> ## Documentation Index
> Fetch the complete documentation index at: https://kosli-29-automate-helm-reference-updates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# kosli assert artifact

> Assert the compliance status of an artifact in Kosli.  There are four (mutually exclusive) ways to use `kosli assert artifact`:
1. Against an environment. When `--environment` is specified, assert...

## Synopsis

```shell theme={"theme":"dracula"}
kosli assert artifact [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags]
```

Assert the compliance status of an artifact in Kosli.
There are four (mutually exclusive) ways to use `kosli assert artifact`:

1. Against an environment. When `--environment` is specified,
   asserts against all policies currently attached to the given environment.
2. Against one or more policies. When `--policy` is specified,
   asserts against all the given policies.
3. Against a flow. When `--flow` is specified, asserts against the
   current template file of the given flow.
4. Against many flows. When none of  `--environment`, `--policy`, or `--flow`
   are specified, asserts against the template files of *all* flows the artifact
   is found in (by fingerprint).

Exits with zero code if the artifact has compliant status,
non-zero code if non-compliant status.

## 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). |
| -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.                                                                                                           |
| --environment string       | The Kosli environment name to assert the artifact against.                                                                                                                                                                                     |
| -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.                                                                                                                                                                                                                           |
| -h, --help                 | help for artifact                                                                                                                                                                                                                              |
| -o, --output string        | \[defaulted] The format of the output. Valid formats are: \[table, json]. (default "table")                                                                                                                                                    |
| --policy strings           | \[optional] policy name (can be specified multiple times)                                                                                                                                                                                      |
| --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.                                                                                              |

## 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](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.                                                                                                                          |

## Live Examples in different CI systems

<Tabs>
  <Tab title="GitHub">
    View an example of the `kosli assert artifact` command in GitHub.

    In [this YAML file](https://app.kosli.com/api/v2/livedocs/cyber-dojo/yaml?ci=github\&command=kosli+assert+artifact), which created [this Kosli Event](https://app.kosli.com/api/v2/livedocs/cyber-dojo/event?ci=github\&command=kosli+assert+artifact).
  </Tab>

  <Tab title="GitLab">
    View an example of the `kosli assert artifact` command in GitLab.

    In [this YAML file](https://app.kosli.com/api/v2/livedocs/cyber-dojo/yaml?ci=gitlab\&command=kosli+assert+artifact), which created [this Kosli Event](https://app.kosli.com/api/v2/livedocs/cyber-dojo/event?ci=gitlab\&command=kosli+assert+artifact).
  </Tab>
</Tabs>

## 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="assert that an artifact meets all compliance requirements for an environment">
    ```shell theme={"theme":"dracula"}
    kosli assert artifact 
    	--fingerprint 184c799cd551dd1d8d5c5f9a5d593b2e931f5e36122ee5c793c1d08a19839cc0 
    	--environment prod 

    ```
  </Accordion>

  <Accordion title="assert that an artifact meets a set of policies">
    ```shell theme={"theme":"dracula"}
    kosli assert artifact 
    	--fingerprint 184c799cd551dd1d8d5c5f9a5d593b2e931f5e36122ee5c793c1d08a19839cc0 
    	--policy has-approval,has-been-integration-tested 

    ```
  </Accordion>

  <Accordion title="fail if an artifact has a non-compliant status in a single flow (using the artifact fingerprint)">
    ```shell theme={"theme":"dracula"}
    export KOSLI_FLOW=yourFlowName
    kosli assert artifact 
    	--fingerprint 184c799cd551dd1d8d5c5f9a5d593b2e931f5e36122ee5c793c1d08a19839cc0 

    ```
  </Accordion>

  <Accordion title="fail if an artifact has a non-compliant status in any flow (using the artifact name and type)">
    ```shell theme={"theme":"dracula"}
    unset KOSLI_FLOW
    kosli assert artifact library/nginx:1.21 
    	--artifact-type docker 
    ```
  </Accordion>
</AccordionGroup>
