> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kosli.com/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>

## Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://docs.kosli.com/feedback

```json
{
  "path": "/client_reference/kosli_report_artifact",
  "feedback": "Description of the issue"
}
```

Only submit feedback when you have something specific and actionable to report.

</AgentInstructions>

# kosli report artifact

> Report an artifact creation to a Kosli flow.  

<Warning>
  **kosli report artifact** is deprecated. see kosli attest commands  Deprecated commands will be removed in a future release.
</Warning>

## Synopsis

```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
kosli report artifact {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags]
```

Report an artifact creation to a Kosli flow.

The artifact fingerprint can be provided directly with the `--fingerprint` flag, or
calculated based on `--artifact-type` flag.

Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container
images in registries or "docker" for local docker images.

Note: `--artifact-type=docker` reads the image's repo digest via the local Docker daemon.
The image must have been pushed to or pulled from a registry for a repo digest to exist;
a freshly built image (just `docker build`) will not have one. If the image is already in
a registry, prefer `--artifact-type=oci`, which fetches the digest directly from the
registry without needing a local Docker daemon.

## Flags

| Flag                       | Description                                                                                                                                                                                                                                    |
| :------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -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). |
| -b, --build-url string     | The url of CI pipeline that built the artifact. (defaulted in some CIs: [docs](/integrations/ci_cd) ).                                                                                                                                         |
| -u, --commit-url string    | The url for the git commit that created the artifact. (defaulted in some CIs: [docs](/integrations/ci_cd) ).                                                                                                                                   |
| -D, --dry-run              | \[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.                                                                                 |
| -F, --fingerprint string   | \[conditional] The SHA256 fingerprint of the artifact. Only required if you don't specify '--artifact-type'.                                                                                                                                   |
| -f, --flow string          | The Kosli flow name.                                                                                                                                                                                                                           |
| -g, --git-commit string    | \[defaulted] The git commit from which the artifact was created. (defaulted in some CIs: [docs](/integrations/ci_cd), otherwise defaults to HEAD ).                                                                                            |
| -h, --help                 | help for artifact                                                                                                                                                                                                                              |
| -n, --name string          | \[optional] Artifact display name, if different from file, image or directory name.                                                                                                                                                            |
| --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.                                                                              |
| --registry-username string | \[conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry.                                                                                              |
| --repo-root string         | \[defaulted] The directory where the source git repository is available. (default ".")                                                                                                                                                         |

## Flags inherited from parent commands

| Flag                      | Description                                                                                                 |
| :------------------------ | :---------------------------------------------------------------------------------------------------------- |
| -a, --api-token string    | The Kosli API token.                                                                                        |
| -c, --config-file string  | \[optional] The Kosli config file path. (default "kosli")                                                   |
| --debug                   | \[optional] Print debug logs to stdout. A boolean flag [docs](/faq/#boolean-flags) (default false)          |
| -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.                                                                                     |

## 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).

<AccordionGroup>
  <Accordion title="Report to a Kosli flow that a file type artifact has been created">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli report artifact FILE.tgz
    	--artifact-type file
    	--build-url https://exampleci.com
    	--commit-url https://github.com/YourOrg/YourProject/commit/yourCommitShaThatThisArtifactWasBuiltFrom
    	--git-commit yourCommitShaThatThisArtifactWasBuiltFrom

    ```
  </Accordion>

  <Accordion title="Report to a Kosli flow that an artifact with a provided fingerprint (sha256) has been created">
    ```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
    kosli report artifact ANOTHER_FILE.txt
    	--build-url https://exampleci.com
    	--commit-url https://github.com/YourOrg/YourProject/commit/yourCommitShaThatThisArtifactWasBuiltFrom
    	--git-commit yourCommitShaThatThisArtifactWasBuiltFrom
    	--fingerprint yourArtifactFingerprint
    ```
  </Accordion>
</AccordionGroup>