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.
Synopsis
FLOW-NAMEs must start with a letter or number, and only contain letters, numbers, ., -, _, and ~.
Flags
| Flag | Description |
|---|---|
--description string | [optional] The Kosli flow description. |
-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, --help | help for flow |
-t, --template strings | [defaulted] The comma-separated list of required compliance controls names. |
-f, --template-file string | [optional] The path to a yaml template file. Cannot be used together with --use-empty-template |
--use-empty-template | Use an empty template for the flow creation without specifying a file. Cannot be used together with --template or --template-file |
--visibility string | [defaulted] The visibility of the Kosli flow. Valid visibilities are [public, private]. (default “private”) |
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. |
-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 string | The 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. |
Live Examples in different CI systems
- GitHub
- GitLab
View an example of the
kosli create flow command in GitHub.In this YAML fileExamples Use Cases
These examples all assume that the flags--api-token, --org, --host, (and --flow, --trail when required), are set/provided.
create/update a Kosli flow (with empty template)
create/update a Kosli flow (with empty template)
create/update a Kosli flow (with template file)
create/update a Kosli flow (with template file)