You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update CLI and helm reference for v2.36.4 (#353)
Automated update of CLI and Helm reference documentation for release
`v2.36.4`.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|`--debug`|[optional] Print debug logs to stdout.|
23
-
|`-h`, `--help`|help for kosli|
24
-
|`-H`, `--host` string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
25
-
|`--http-proxy` string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
26
-
|`-r`, `--max-api-retries` int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)|
27
-
|`--org` string |The Kosli organization.|
28
-
|`-q`, `--quiet`|[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins.|
18
+
| Flag |Type |Description |
19
+
| :--- | :--- | :--- |
20
+
|`-a`, `--api-token`|string |The Kosli API token. |
|`--debug`| bool |[optional] Print debug logs to stdout. |
23
+
|`-h`, `--help`| bool |help for kosli |
24
+
|`-H`, `--host`|string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
25
+
|`--http-proxy`|string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
26
+
|`-r`, `--max-api-retries`|int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) |
27
+
|`--org`|string |The Kosli organization. |
28
+
|`-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. |
Copy file name to clipboardExpand all lines: client_reference/kosli_allow_artifact.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,30 +39,30 @@ is set), registry credentials are resolved as follows:
39
39
40
40
41
41
## Flags
42
-
| Flag | Description |
43
-
| :--- | :--- |
44
-
|`-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).|
45
-
|`-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.|
46
-
|`-e`, `--environment` string |The environment name for which the artifact is allowlisted.|
47
-
|`-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.|
48
-
|`-F`, `--fingerprint` string |[conditional] The SHA256 fingerprint of the artifact. Only required if you don't specify '`--artifact-type`'.|
49
-
|`-h`, `--help`|help for artifact|
50
-
|`--reason` string |The reason why this artifact is allowlisted.|
51
-
|`--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 and it is not already accessible via Docker/Podman auth files or a credential helper.|
52
-
|`--registry-provider` string |[deprecated] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. (DEPRECATED: no longer used)|
53
-
|`--registry-username` string |[conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry and it is not already accessible via Docker/Podman auth files or a credential helper.|
42
+
| Flag |Type |Description |
43
+
| :--- | :--- | :--- |
44
+
|`-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). |
45
+
|`-D`, `--dry-run`| bool |[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. |
46
+
|`-e`, `--environment`|string |The environment name for which the artifact is allowlisted. |
47
+
|`-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. |
48
+
|`-F`, `--fingerprint`|string |[conditional] The SHA256 fingerprint of the artifact. Only required if you don't specify '`--artifact-type`'. |
49
+
|`-h`, `--help`| bool |help for artifact |
50
+
|`--reason`|string |The reason why this artifact is allowlisted. |
51
+
|`--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 and it is not already accessible via Docker/Podman auth files or a credential helper. |
52
+
|`--registry-provider`|string |[deprecated] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. (DEPRECATED: no longer used) |
53
+
|`--registry-username`|string |[conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry and it is not already accessible via Docker/Podman auth files or a credential helper. |
54
54
55
55
56
56
## Flags inherited from parent commands
57
-
| Flag | Description |
58
-
| :--- | :--- |
59
-
|`-a`, `--api-token` string |The Kosli API token.|
|`--debug`|[optional] Print debug logs to stdout.|
62
-
|`-H`, `--host` string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
63
-
|`--http-proxy` string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
64
-
|`-r`, `--max-api-retries` int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)|
65
-
|`--org` string |The Kosli organization.|
66
-
|`-q`, `--quiet`|[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins.|
57
+
| Flag |Type |Description |
58
+
| :--- | :--- | :--- |
59
+
|`-a`, `--api-token`|string |The Kosli API token. |
|`--debug`| bool |[optional] Print debug logs to stdout. |
62
+
|`-H`, `--host`|string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
63
+
|`--http-proxy`|string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
64
+
|`-r`, `--max-api-retries`|int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) |
65
+
|`--org`|string |The Kosli organization. |
66
+
|`-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. |
Copy file name to clipboardExpand all lines: client_reference/kosli_archive_attestation-type.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,23 +14,23 @@ New custom attestations using this type cannot be made, but existing attestation
14
14
15
15
16
16
## Flags
17
-
| Flag | Description |
18
-
| :--- | :--- |
19
-
|`-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.|
20
-
|`-h`, `--help`|help for attestation-type|
17
+
| Flag |Type |Description |
18
+
| :--- | :--- | :--- |
19
+
|`-D`, `--dry-run`| bool |[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. |
20
+
|`-h`, `--help`| bool |help for attestation-type |
21
21
22
22
23
23
## Flags inherited from parent commands
24
-
| Flag | Description |
25
-
| :--- | :--- |
26
-
|`-a`, `--api-token` string |The Kosli API token.|
|`--debug`|[optional] Print debug logs to stdout.|
29
-
|`-H`, `--host` string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
30
-
|`--http-proxy` string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
31
-
|`-r`, `--max-api-retries` int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)|
32
-
|`--org` string |The Kosli organization.|
33
-
|`-q`, `--quiet`|[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins.|
24
+
| Flag |Type |Description |
25
+
| :--- | :--- | :--- |
26
+
|`-a`, `--api-token`|string |The Kosli API token. |
|`--debug`| bool |[optional] Print debug logs to stdout. |
29
+
|`-H`, `--host`|string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
30
+
|`--http-proxy`|string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
31
+
|`-r`, `--max-api-retries`|int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) |
32
+
|`--org`|string |The Kosli organization. |
33
+
|`-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. |
Copy file name to clipboardExpand all lines: client_reference/kosli_archive_control.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,23 +20,23 @@ via `kosli list controls --archived`, and can be restored with `kosli unarchive
20
20
21
21
22
22
## Flags
23
-
| Flag | Description |
24
-
| :--- | :--- |
25
-
|`-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.|
26
-
|`-h`, `--help`|help for control|
23
+
| Flag |Type |Description |
24
+
| :--- | :--- | :--- |
25
+
|`-D`, `--dry-run`| bool |[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. |
26
+
|`-h`, `--help`| bool |help for control |
27
27
28
28
29
29
## Flags inherited from parent commands
30
-
| Flag | Description |
31
-
| :--- | :--- |
32
-
|`-a`, `--api-token` string |The Kosli API token.|
|`--debug`|[optional] Print debug logs to stdout.|
35
-
|`-H`, `--host` string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
36
-
|`--http-proxy` string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
37
-
|`-r`, `--max-api-retries` int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)|
38
-
|`--org` string |The Kosli organization.|
39
-
|`-q`, `--quiet`|[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins.|
30
+
| Flag |Type |Description |
31
+
| :--- | :--- | :--- |
32
+
|`-a`, `--api-token`|string |The Kosli API token. |
|`--debug`| bool |[optional] Print debug logs to stdout. |
35
+
|`-H`, `--host`|string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
36
+
|`--http-proxy`|string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
37
+
|`-r`, `--max-api-retries`|int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) |
38
+
|`--org`|string |The Kosli organization. |
39
+
|`-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. |
Copy file name to clipboardExpand all lines: client_reference/kosli_archive_environment.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,23 +14,23 @@ The environment will no longer be visible in list of environments, data is still
14
14
15
15
16
16
## Flags
17
-
| Flag | Description |
18
-
| :--- | :--- |
19
-
|`-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.|
20
-
|`-h`, `--help`|help for environment|
17
+
| Flag |Type |Description |
18
+
| :--- | :--- | :--- |
19
+
|`-D`, `--dry-run`| bool |[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. |
20
+
|`-h`, `--help`| bool |help for environment |
21
21
22
22
23
23
## Flags inherited from parent commands
24
-
| Flag | Description |
25
-
| :--- | :--- |
26
-
|`-a`, `--api-token` string |The Kosli API token.|
|`--debug`|[optional] Print debug logs to stdout.|
29
-
|`-H`, `--host` string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
30
-
|`--http-proxy` string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
31
-
|`-r`, `--max-api-retries` int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)|
32
-
|`--org` string |The Kosli organization.|
33
-
|`-q`, `--quiet`|[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins.|
24
+
| Flag |Type |Description |
25
+
| :--- | :--- | :--- |
26
+
|`-a`, `--api-token`|string |The Kosli API token. |
|`--debug`| bool |[optional] Print debug logs to stdout. |
29
+
|`-H`, `--host`|string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
30
+
|`--http-proxy`|string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
31
+
|`-r`, `--max-api-retries`|int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) |
32
+
|`--org`|string |The Kosli organization. |
33
+
|`-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. |
Copy file name to clipboardExpand all lines: client_reference/kosli_archive_flow.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,23 +14,23 @@ The flow will no longer be visible in list of flows, data is still stored in the
14
14
15
15
16
16
## Flags
17
-
| Flag | Description |
18
-
| :--- | :--- |
19
-
|`-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.|
20
-
|`-h`, `--help`|help for flow|
17
+
| Flag |Type |Description |
18
+
| :--- | :--- | :--- |
19
+
|`-D`, `--dry-run`| bool |[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. |
20
+
|`-h`, `--help`| bool |help for flow |
21
21
22
22
23
23
## Flags inherited from parent commands
24
-
| Flag | Description |
25
-
| :--- | :--- |
26
-
|`-a`, `--api-token` string |The Kosli API token.|
|`--debug`|[optional] Print debug logs to stdout.|
29
-
|`-H`, `--host` string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
30
-
|`--http-proxy` string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
31
-
|`-r`, `--max-api-retries` int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)|
32
-
|`--org` string |The Kosli organization.|
33
-
|`-q`, `--quiet`|[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins.|
24
+
| Flag |Type |Description |
25
+
| :--- | :--- | :--- |
26
+
|`-a`, `--api-token`|string |The Kosli API token. |
|`--debug`| bool |[optional] Print debug logs to stdout. |
29
+
|`-H`, `--host`|string |[defaulted] The Kosli endpoint. (default "https://app.kosli.com")|
30
+
|`--http-proxy`|string |[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`|
31
+
|`-r`, `--max-api-retries`|int |[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) |
32
+
|`--org`|string |The Kosli organization. |
33
+
|`-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. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments