Skip to content

docs: update CLI and helm reference for v2.40.1 #406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbevc1 merged 1 commit into from
Sep 11, 2026
Merged

docs: update CLI and helm reference for v2.40.1 #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion client_reference/kosli_create_api-key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@ Create an API key for a service account.

The key value is only returned once, at creation time, so make sure to store it securely.

Every API key expires. Without `--expires-at` the key is given the maximum allowed
lifetime, and an `--expires-at` beyond that maximum is capped to it.

## Flags
| Flag | Type | Description |
| :--- | :--- | :--- |
| `-d`, `--description` | string | A description for the API key. |
| `-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. |
| `-e`, `--expires-at` | string | [optional] When the API key expires. Accepts an epoch timestamp or a date like '2026-06-04', '2026-06-04 15:04:05', or an RFC3339 timestamp. Defaults to no expiry. |
| `-e`, `--expires-at` | string | [optional] When the API key expires. Accepts an epoch timestamp or a date like '2026-06-04', '2026-06-04 15:04:05', or an RFC3339 timestamp. Keys always expire: when not set, the key gets the maximum allowed lifetime, which also caps later dates. |
| `-h`, `--help` | bool | help for api-key |
| `-o`, `--output` | string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") |
| `-s`, `--service-account` | string | The name of the service account whose API keys are managed. |
Expand Down
18 changes: 9 additions & 9 deletions client_reference/kosli_diff_snapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ kosli diff snapshots aws-beta aws-prod --output=json
```json
{
"snappish1": {
"snapshot_id": "aws-beta#8350",
"snapshot_id": "aws-beta#8357",
"artifacts": [
{
"fingerprint": "1d819a21e793bffbe50a39c9b6b8c4154e0b4271051931839dc8a2fa0c564e2a",
Expand All @@ -84,6 +84,14 @@ kosli diff snapshots aws-beta aws-prod --output=json
"commit_url": "https://github.com/cyber-dojo/exercises-start-points/commit/c61d9342b4008c664ffdabaf851538ede9085b76",
"instance_count": 1
},
{
"fingerprint": "24c1d515da9616682d027f6af5f0bafe6e09e1969883afdf432b18c77d82189d",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/languages-start-points:ce3f78d@sha256:24c1d515da9616682d027f6af5f0bafe6e09e1969883afdf432b18c77d82189d",
"most_recent_timestamp": 1789130323,
"flow": "languages-start-points-ci",
"commit_url": "https://github.com/cyber-dojo/languages-start-points/commit/ce3f78ddf20c5e8cf0ed23fed6d0f89e5180bf2d",
"instance_count": 1
},
{
"fingerprint": "7a8cbbe05f8659a3ad37e537756c313dcb10e25e49ed1a1c9a656bde472ce887",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/web:75d91ed@sha256:7a8cbbe05f8659a3ad37e537756c313dcb10e25e49ed1a1c9a656bde472ce887",
Expand All @@ -108,14 +116,6 @@ kosli diff snapshots aws-beta aws-prod --output=json
"commit_url": "https://github.com/cyber-dojo/custom-start-points/commit/8c3bffd55590a7d6c180980b263117096a9add32",
"instance_count": 1
},
{
"fingerprint": "ba00a3efafbea83322e018ae78fd97defd8f018c794a135859dcc02a7e70bd5c",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/languages-start-points:da21200@sha256:ba00a3efafbea83322e018ae78fd97defd8f018c794a135859dcc02a7e70bd5c",
"most_recent_timestamp": 1789113338,
"flow": "languages-start-points-ci",
"commit_url": "https://github.com/cyber-dojo/languages-start-points/commit/da2120004a066092cc36c0f8d20f5186106b3d04",
"instance_count": 1
},
{
"fingerprint": "ba63a80521117f0778ca0e2f564fffba0926292eeeaf0a9e1103952fafbec472",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/spooler:a339a8f@sha256:ba63a80521117f0778ca0e2f564fffba0926292eeeaf0a9e1103952fafbec472",
Expand Down
4 changes: 2 additions & 2 deletions client_reference/kosli_get_environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ kosli get environment aws-prod --output=json
"name": "aws-prod",
"type": "ECS",
"description": "The ECS cluster for production cyber-dojo",
"last_modified_at": 1789114018.585112,
"last_reported_at": 1789114018.585112,
"last_modified_at": 1789138978.7731013,
"last_reported_at": 1789138978.7731013,
"last_changed_at": 1789108858.5535865,
"state": true,
"include_scaling": false,
Expand Down
24 changes: 12 additions & 12 deletions client_reference/kosli_list_environments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ kosli list environments --output=json
"name": "aws-beta",
"type": "ECS",
"description": "The ECS cluster for staging cyber-dojo",
"last_modified_at": 1789114043.9935918,
"last_reported_at": 1789114043.9935918,
"last_changed_at": 1789113443.9263997,
"last_modified_at": 1789138943.8798323,
"last_reported_at": 1789138943.8798323,
"last_changed_at": 1789130423.8240678,
"state": true,
"include_scaling": false,
"tags": {
Expand All @@ -84,9 +84,9 @@ kosli list environments --output=json
"name": "aws-beta-terraform-drift-detection",
"type": "server",
"description": "Detection of drift of the Infrastructure-as-code components of aws-beta",
"last_modified_at": 1789113909.1972687,
"last_reported_at": 1789113909.1972687,
"last_changed_at": 1789113909.1972687,
"last_modified_at": 1789138820.2430296,
"last_reported_at": 1789138820.2430296,
"last_changed_at": 1789130708.8031085,
"state": true,
"include_scaling": false,
"tags": {},
Expand All @@ -100,8 +100,8 @@ kosli list environments --output=json
"name": "aws-prod",
"type": "ECS",
"description": "The ECS cluster for production cyber-dojo",
"last_modified_at": 1789114018.585112,
"last_reported_at": 1789114018.585112,
"last_modified_at": 1789138978.7731013,
"last_reported_at": 1789138978.7731013,
"last_changed_at": 1789108858.5535865,
"state": true,
"include_scaling": false,
Expand All @@ -122,8 +122,8 @@ kosli list environments --output=json
"name": "aws-prod-terraform-drift-detection",
"type": "server",
"description": "Detection of drift of the Infrastructure-as-code components of aws-prod",
"last_modified_at": 1789113812.7967694,
"last_reported_at": 1789113812.7967694,
"last_modified_at": 1789138712.2939506,
"last_reported_at": 1789138712.2939506,
"last_changed_at": 1789033111.9033823,
"state": true,
"include_scaling": false,
Expand Down Expand Up @@ -155,9 +155,9 @@ kosli list environments --output=json
"name": "staging",
"type": "logical",
"description": "Staging environments for cyber-dojo",
"last_modified_at": 1789113909.1972687,
"last_modified_at": 1789130708.8031085,
"last_reported_at": null,
"last_changed_at": 1789113909.1972687,
"last_changed_at": 1789130708.8031085,
"state": true,
"include_scaling": false,
"tags": {},
Expand Down
6 changes: 3 additions & 3 deletions client_reference/kosli_list_flows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ kosli list flows --output=json
"kind": "build",
"env": "aws-beta"
},
"latest_activity_at": 1789113443.9263997,
"latest_activity_at": 1789130423.8240678,
"latest_state": "COMPLIANT"
},
{
Expand Down Expand Up @@ -235,7 +235,7 @@ kosli list flows --output=json
"kind": "release",
"env": "aws-prod"
},
"latest_activity_at": 1789023183.9163306,
"latest_activity_at": 1789129363.806646,
"latest_state": "COMPLIANT"
},
{
Expand Down Expand Up @@ -454,7 +454,7 @@ kosli list flows --output=json
"template": "version: 1\ntrail:\n attestations:\n - name: terraform-plan\n type: generic\n - name: terraform-apply\n type: generic\n artifacts:\n - name: terraform-state\n - name: drift-plan\n",
"repo_url": "https://github.com/cyber-dojo/languages-start-points",
"tags": {},
"latest_activity_at": 1789113909.1972687,
"latest_activity_at": 1789130708.8031085,
"latest_state": "COMPLIANT"
},
{
Expand Down
2 changes: 1 addition & 1 deletion client_reference/kosli_list_snapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ kosli list snapshots aws-prod --output=json
"from": 1789108858.5535865,
"to": 0.0,
"compliant": true,
"duration": 5193.242860555649
"duration": 30143.66504883766
},
{
"index": 5351,
Expand Down
10 changes: 5 additions & 5 deletions client_reference/kosli_rotate_api-key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ kosli rotate api-key KEY-ID [KEY-ID...] [flags]
Rotate one or more API keys for a service account.

A new API key is generated immediately. The old key remains valid for a grace period to
allow time to update dependent systems; the length of that grace period is server-managed
unless overridden with `--grace-period-hours`. The new key value is only returned once, so
make sure to store it securely.
allow time to update dependent systems; that grace period has a standard length unless
overridden with `--grace-period-hours`. The new key value is only returned once, so make
sure to store it securely.

## Flags
| Flag | Type | Description |
| :--- | :--- | :--- |
| `-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. |
| `-e`, `--expires-at` | string | [optional] When the API key expires. Accepts an epoch timestamp or a date like '2026-06-04', '2026-06-04 15:04:05', or an RFC3339 timestamp. Defaults to no expiry. |
| `-g`, `--grace-period-hours` | int | [optional] How many hours the old API key remains valid after rotation, to allow time to update dependent systems. Defaults to the server-side value when not set. |
| `-e`, `--expires-at` | string | [optional] When the new API key expires. Accepts an epoch timestamp or a date like '2026-06-04', '2026-06-04 15:04:05', or an RFC3339 timestamp. Defaults to the rotated key's current expiry, and is capped by the maximum allowed key lifetime. |
| `-g`, `--grace-period-hours` | int | [optional] How many hours the old API key remains valid after rotation, to allow time to update dependent systems. Defaults to the standard grace period when not set. |
| `-h`, `--help` | bool | help for api-key |
| `-o`, `--output` | string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") |
| `-s`, `--service-account` | string | The name of the service account whose API keys are managed. |
Expand Down
2 changes: 1 addition & 1 deletion client_reference/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Reference documentation for the Kosli CLI."
---

<Info>
This reference was generated from Kosli CLI **v2.40.0**.
This reference was generated from Kosli CLI **v2.40.1**.
</Info>

The Kosli CLI allows you to interact with Kosli from your terminal and CI/CD pipelines.
Expand Down