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 get flow FLOW-NAME [flags]
Get the metadata of a specific flow.

Flags

FlagDescription
-h, —helphelp for flow
-o, —output string[defaulted] The format of the output. Valid formats are: [table, json]. (default “table”)

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.

Live Example

To view a live example of ‘kosli get flow’ you can run the command below (for the cyber-dojo demo organization).
export KOSLI_ORG=cyber-dojo
# The API token below is read-only
export KOSLI_API_TOKEN=Pj_XT2deaVA6V1qrTlthuaWsmjVt4eaHQwqnwqjRO3A
kosli get flow dashboard-ci --output=json
{
  "name": "dashboard-ci",
  "description": "UX for a group practice dashboard",
  "visibility": "private",
  "org": "cyber-dojo",
  "template": "version: 1\n\ntrail:\n  attestations:\n    - name: pull-request\n      type: pull_request\n  artifacts:\n    - name: dashboard\n      attestations:\n        - name: rubocop-lint\n          type: junit\n        - name: snyk-container-scan\n          type: generic\n        - name: sonarcloud-scan\n          type: sonar\n        - name: unit-test\n          type: junit\n        - name: unit-test-coverage\n          type: generic\n",
  "repo_url": "https://github.com/cyber-dojo/dashboard",
  "tags": {
    "ci": "github",
    "repo_url": "https://github.com/cyber-dojo/dashboard",
    "kind": "build"
  }
}
Last modified on May 11, 2026