> ## Documentation Index > Fetch the complete documentation index at: https://kosli-docs-snapshot-deployment-diffs.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # kosli attest jira > Report a jira attestation to an artifact or a trail in a Kosli flow. ## Synopsis ```shell theme={null} kosli attest jira [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] ``` Report a jira attestation to an artifact or a trail in a Kosli flow.\ By default, parses the given commit's message, current branch name, or the content of the `--jira-secondary-source` argument for Jira issue references. Use `--jira-trailer` to read issue keys exclusively from a named git trailer line instead (e.g. `Jira: PROJ-42`); only the last block of lines in the commit message is scanned (everything after the final blank line, or the whole message if there is no blank line). The rest of the commit message and branch name are not scanned. `--jira-trailer` and `--jira-secondary-source` are mutually exclusive. Jira issue references have the form: 'at least 2 characters long, starting with an uppercase letter project key followed by dash and one or more digits'. Matching is case-insensitive: `proj-42` and `PROJ-42` in a commit message are both recognised and returned as `PROJ-42`. Any token that matches the Jira key format (a word boundary, two or more letters/digits starting with a letter, a dash, and one or more digits) is treated as a candidate, regardless of whether it is an intentional Jira reference. For example, a commit message `see note-1 for context, fixes PROJ-42` will look up both `NOTE-1` and `PROJ-42` in Jira. If `NOTE-1` does not exist, the attestation will be non-compliant even though `PROJ-42` is valid. Use `--jira-project-key` to restrict matching to one or more known project keys and avoid unintended candidates. Any candidate match is automatically excluded if every occurrence in the parsed text is immediately followed by a hyphen and a digit — for example, `CVE-2026-41284` is excluded because `CVE-2026` would be followed by `-4`. This applies across all parsed sources (commit message, branch name, and secondary source). Note: if your Jira project key collides with this pattern (e.g. a project key of `CVE`), an issue reference that happens to be the prefix of a longer hyphenated number (such as a CVE identifier) will be filtered out. Use `--jira-trailer` to read issue keys from a dedicated git trailer line (e.g. `Jira: CVE-42`), which confines scanning to the trailer value and removes collisions caused by surrounding commit text; write the issue key alone in the trailer value, not embedded in a longer hyphenated string (e.g. `Jira: CVE-2026-41284` would still be filtered out). Alternatively, use `--jira-secondary-source` with a different identifier format. If you want to restrict the Jira issue matching to a specific project, use the `--jira-project-key` flag to specify your own project key. You can specify multiple project keys if needed. If the `--ignore-branch-match` is set, the branch name is not parsed for a match. `--ignore-branch-match` has no effect when `--jira-trailer` is set, since the branch is never scanned in trailer mode. The found issue references will be checked against Jira to confirm their existence. The attestation is reported in all cases, and its compliance status depends on referencing existing Jira issues. A reachable but wrong base URL still surfaces as a non-existent issue, because Jira answers 404 both for an issue that does not exist and for one you may not view. A base URL that cannot be reached is reported as not confirmed, with the transport error as the reason. A credential rejection is likewise detected and reported as not confirmed, with a warning identifying the credentials. Use `--debug` to see the status Jira returned per issue. The `--jira-issue-fields` can be used to include fields from the jira issue. By default no fields are included. `*all` will give all fields. Using `--jira-issue-fields "*all" --dry-run` will give you the complete list so you can select the once you need. The issue fields uses the jira API that is documented here: [https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-issueidorkey-get-request](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-issueidorkey-get-request) The attestation can be bound to a *trail* using the trail name. The attestation can be bound to an *artifact* in two ways: * using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). * using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact. To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact. Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`. The `.kosli_ignore` file is always treated as part of the artifact: its own entries cannot exclude it, so the exclusion list cannot be changed without changing the fingerprint. Paths the list already matches stay excluded whatever is later added there, so keep its entries as narrow as possible. Excluding the file with `--exclude` keeps it out of the fingerprint but still applies the paths it lists, which lets a writable directory change the list again. To drop the file from the fingerprint safely, move its entries to `--exclude` and delete it. You can optionally associate the attestation to a git commit using `--commit` (requires access to a git repo). You can optionally redact some of the git commit data sent to Kosli using `--redact-commit-info`. Note that when the attestation is reported for an artifact that does not yet exist in Kosli, `--commit` is required to facilitate binding the attestation to the right artifact. To record repository information, all three of `--repo-id`, `--repo-url`, and `--repository` must be set together. These are automatically set in GitHub Actions, GitLab CI, Bitbucket Pipelines, and Azure DevOps. In other CI systems, set them explicitly to capture repository metadata. ## Flags | Flag | Type | Description | | :------------------------ | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--annotate` | stringToString | \[optional] Annotate the attestation with data using key=value. | | `-t`, `--artifact-type` | string | The type of the artifact to calculate its SHA256 fingerprint. One of: \[oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '`--fingerprint`' on commands that allow it). | | `--assert` | bool | \[optional] Exit with non-zero code if the attestation is non-compliant | | `--attachments` | strings | \[optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli's evidence vault. | | `-g`, `--commit` | string | \[conditional] The git commit for which the attestation is associated to. Becomes required when reporting an attestation for an artifact before reporting it to Kosli. (defaulted in some CIs: [docs](/integrations/ci_cd) ). | | `--description` | string | \[optional] attestation description | | `-D`, `--dry-run` | bool | \[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | | `-x`, `--exclude` | strings | \[optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns. Only applicable for `--artifact-type` dir. | | `--external-fingerprint` | stringToString | \[optional] A SHA256 fingerprint of an external attachment represented by `--external-url`. The format is label=fingerprint (labels cannot contain '.' or '='). This flag can be set multiple times. There must be an external url with a matching label for each external fingerprint. | | `--external-url` | stringToString | \[optional] Add labeled reference URL for an external resource. The format is label=url (labels cannot contain '.' or '='). This flag can be set multiple times. If the resource is a file or dir, you can optionally add its fingerprint via `--external-fingerprint` | | `-F`, `--fingerprint` | string | \[conditional] The SHA256 fingerprint of the artifact to attach the attestation to. Only required if the attestation is for an artifact and `--artifact-type` and artifact name/path are not used. | | `-f`, `--flow` | string | The Kosli flow name. | | `-h`, `--help` | bool | help for jira | | `--ignore-branch-match` | bool | Ignore branch name when searching for Jira ticket reference. | | `--jira-api-token` | string | Jira API token (for Jira Cloud) | | `--jira-base-url` | string | The base url for the jira project, e.g. `https://kosli.atlassian.net` | | `--jira-issue-fields` | string | \[optional] The comma separated list of fields to include from the Jira issue. Default no fields are included. '\*all' will give all fields. | | `--jira-pat` | string | Jira personal access token (for self-hosted Jira) | | `--jira-project-key` | strings | \[optional] Jira project key to match against. Can be repeated, or given as a comma-separated list. Defaults to matching any jira project key. | | `--jira-secondary-source` | string | \[optional] An optional string to search for Jira ticket reference, e.g. '`--jira-secondary-source` \$\{\{ github.head\_ref }}'. Mutually exclusive with `--jira-trailer`. | | `--jira-trailer` | string | \[optional] The git trailer key to use as the sole source of Jira issue references (e.g. '`--jira-trailer` Jira' extracts the value of 'Jira: `issue-key`' lines from the final paragraph of the commit message). When set, the rest of the commit message and branch name are not scanned. Mutually exclusive with `--jira-secondary-source`. | | `--jira-username` | string | Jira username (for Jira Cloud) | | `-n`, `--name` | string | The name of the attestation as declared in the flow or trail yaml template. | | `-o`, `--origin-url` | string | \[optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: [docs](/integrations/ci_cd/#defaulted-kosli-command-flags-from-ci-variables) ). | | `--redact-commit-info` | strings | \[optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of \[author, message, branch]. | | `--registry-password` | string | \[conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry and it is not already accessible via Docker/Podman auth files or a credential helper. | | `--registry-provider` | string | \[deprecated] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. (DEPRECATED: no longer used) | | `--registry-username` | string | \[conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry and it is not already accessible via Docker/Podman auth files or a credential helper. | | `--repo-id` | string | \[conditional] The stable, unique identifier for the repository in your VCS provider (e.g. a numeric ID). Do not use the repository name as it can change if the repo is renamed. All three of `--repo-id`, `--repo-url` and `--repository` must be set to record repository information (defaulted in some CIs: [docs](/integrations/ci_cd) ). | | `--repo-provider` | string | \[optional] The source code hosting provider. One of: github, gitlab, bitbucket, bitbucket\_cloud, bitbucket\_dc, azure-devops, azure\_devops\_services, azure\_devops\_server, git, subversion (defaulted in some CIs: [docs](/integrations/ci_cd) ). | | `--repo-root` | string | \[defaulted] The directory where the source git repository is available. Only used if `--commit` is used or defaulted in CI, see [docs](/integrations/ci_cd/#defaulted-kosli-command-flags-from-ci-variables) . (default ".") | | `--repo-url` | string | \[conditional] The URL of the repository. Must be a valid URL. All three of `--repo-id`, `--repo-url` and `--repository` must be set to record repository information (defaulted in some CIs: [docs](/integrations/ci_cd) ). | | `--repository` | string | \[conditional] The name of the repository (e.g. owner/repo-name). All three of `--repo-id`, `--repo-url` and `--repository` must be set to record repository information (defaulted in some CIs: [docs](/integrations/ci_cd) ). | | `-T`, `--trail` | string | The Kosli trail name. | | `-u`, `--user-data` | string | \[optional] The path to a JSON file containing additional data you would like to attach to the attestation. The maximum JSON payload size is 1MB. | ## Flags inherited from parent commands | Flag | Type | Description | | :------------------------ | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `-a`, `--api-token` | string | The Kosli API token. | | `-c`, `--config-file` | string | \[optional] The Kosli config file path. Config is read from this path or the default only, never implicitly from the current directory. (default "\$HOME/.kosli.yml") | | `--debug` | bool | \[optional] Print debug logs to stdout. | | `-H`, `--host` | string | \[defaulted] The Kosli endpoint. (default "[https://app.kosli.com](https://app.kosli.com)") | | `--http-proxy` | string | \[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port` | | `-r`, `--max-api-retries` | int | \[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | | `--org` | string | The Kosli organization. | | `-q`, `--quiet` | bool | \[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins. | ## Examples Use Cases These examples all assume that the flags `--api-token`, `--org`, `--host`, (and `--flow`, `--trail` when required), are [set/provided](/getting_started/install/#assigning-flags-via-environment-variables). ```shell theme={null} kosli attest jira yourDockerImageName --artifact-type docker --name yourAttestationName --jira-base-url https://kosli.atlassian.net --jira-username user@domain.com --jira-api-token yourJiraAPIToken ``` ```shell theme={null} kosli attest jira --fingerprint yourDockerImageFingerprint --name yourAttestationName --jira-base-url https://kosli.atlassian.net --jira-username user@domain.com --jira-api-token yourJiraAPIToken ``` ```shell theme={null} kosli attest jira --name yourAttestationName --jira-base-url https://kosli.atlassian.net --jira-username user@domain.com --jira-api-token yourJiraAPIToken ``` ```shell theme={null} kosli attest jira --name yourAttestationName --jira-base-url https://kosli.atlassian.net --jira-username user@domain.com --jira-api-token yourJiraAPIToken --jira-project-key ABC ``` ```shell theme={null} kosli attest jira --name yourAttestationName --jira-base-url https://kosli.atlassian.net --jira-username user@domain.com --jira-api-token yourJiraAPIToken --jira-issue-fields "summary,description,creator" ``` ```shell theme={null} kosli attest jira --name yourTemplateArtifactName.yourAttestationName --commit yourArtifactGitCommit --jira-base-url https://kosli.atlassian.net --jira-username user@domain.com --jira-api-token yourJiraAPIToken ``` ```shell theme={null} kosli attest jira --name yourAttestationName --jira-base-url https://kosli.atlassian.net --jira-username user@domain.com --jira-api-token yourJiraAPIToken --attachments yourAttachmentPathName ``` ```shell theme={null} kosli attest jira --name yourAttestationName --jira-base-url https://kosli.atlassian.net --jira-username user@domain.com --jira-api-token yourJiraAPIToken --assert ``` ```shell theme={null} kosli attest jira --name yourAttestationName --jira-secondary-source ${{ github.head_ref }} --jira-base-url https://kosli.atlassian.net --jira-username user@domain.com --jira-api-token yourJiraAPIToken ``` ```shell theme={null} ``` ```shell theme={null} ``` ```shell theme={null} ``` ```shell theme={null} kosli attest jira --name yourAttestationName --jira-trailer Jira --jira-base-url https://kosli.atlassian.net --jira-username user@domain.com --jira-api-token yourJiraAPIToken ```