kosli_get_flow.md

title	kosli get flow
description	Get the metadata of a specific flow.

Synopsis

kosli get flow FLOW-NAME [flags]

Get the metadata of a specific flow.

Flags

Flag	Type	Description
-h, --help	bool	help for flow
-o, --output	string	[defaulted] The format of the output. Valid formats are: [table, json]. (default "table")

Flags inherited from parent commands

Flag	Type	Description
-a, --api-token	string	The Kosli API token.
-c, --config-file	string	[optional] The Kosli config file path. Config is read from this path or the default only, never implicitly from the current directory. (default "$HOME/.kosli.yml")
--debug	bool	[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	bool	[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

{
  "id": "f60c8f3f-67cd-4496-8e17-ed6fdb1e",
  "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: provenance-facts\n          type: custom:provenance-facts\n        - name: provenance-decision\n          type: decision\n\n        - name: sbom-facts\n          type: custom:sbom-facts\n        - name: sbom-decision\n          type: decision\n\n        - name: snyk-container-scan\n          type: decision\n\n        - name: rubocop-lint\n          type: junit\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",
    "env": "aws-beta"
  }
}