Skip to main content

Documentation Index

Fetch the complete documentation index at: https://kosli-reference-docs-v2-17-8.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Synopsis

kosli assert snapshot ENVIRONMENT-NAME-OR-EXPRESSION [flags]
Assert the compliance status of an environment in Kosli. Exits with non-zero code if the environment has a non-compliant status. The expected argument is an expression to specify the specific environment snapshot to assert. It has the format ENVIRONMENT_NAME[SEPARATOR][SNAPSHOT_REFERENCE] Separators can be:
  • ’#’ to specify a specific snapshot number for the environment that is being asserted.
  • ’~’ to get N-th behind the latest snapshot.
Examples of valid expressions are:
  • prod (latest snapshot of prod)
  • prod#10 (snapshot number 10 of prod)
  • prod~2 (third latest snapshot of prod)

Flags

FlagDescription
-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.
-h, —helphelp for snapshot

Flags inherited from parent commands

FlagDescription
-a, —api-token stringThe Kosli API token.
-c, —config-file string[optional] The Kosli config file path. (default “kosli”)
—debug[optional] Print debug logs to stdout.
-H, —host string[defaulted] The Kosli endpoint. (default “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 stringThe Kosli organization.
-q, —quiet[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.
kosli assert snapshot prod#5 \
	--api-token yourAPIToken \
	--org yourOrgName
Last modified on May 11, 2026