Skip to content

docs: update CLI and helm reference for v2.39.1 #375

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
Aug 30, 2026
Merged

docs: update CLI and helm reference for v2.39.1 #375

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
12 changes: 7 additions & 5 deletions client_reference/kosli_attest_jira.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,13 @@ If the `--ignore-branch-match` is set, the branch name is not parsed for a match

The found issue references will be checked against Jira to confirm their existence.
The attestation is reported in all cases, and its compliance status depends on referencing
existing Jira issues.
If you have wrong Jira credentials or wrong Jira-base-url it will be reported as non existing Jira issue.
This is because Jira returns same 404 error code in all cases. When Jira's response shows that it did not
accept the credentials, a warning naming them is printed and the issue is reported as not confirmed rather
than silently as missing; run with `--debug` to see the status Jira returned for each issue.
existing Jira issues.

A reachable but wrong base URL still surfaces as a non-existent issue, because Jira answers 404
both for an issue that does not exist and for one you may not view. A base URL that cannot be
reached is reported as not confirmed, with the transport error as the reason. A credential
rejection is likewise detected and reported as not confirmed, with a warning identifying the
Comment on lines +45 to +49

@claude claude Bot Aug 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improvement — this rewritten paragraph is the only substantive prose change in the PR, and a few things read ambiguously for a reference page:

  1. for one you may not view — may not is ambiguous between permission and possibility. one you do not have permission to view is unambiguous.
  2. The causal link is loose. The sentence claims a wrong base URL surfaces as a non-existent issue because Jira 404s for both "issue missing" and "issue not visible". Those two 404 cases explain the permission scenario, not the wrong-base-URL scenario. Splitting them would be clearer.
  3. The flag isn't named. The previous text said "wrong Jira-base-url"; the new text only says "base URL". On a lookup-oriented reference page, naming --jira-base-url (documented at line 93) helps readers connect the prose to the flag.
  4. Three distinct outcomes in one paragraph. Reachable-but-wrong URL → reported missing; unreachable URL → not confirmed + transport error; rejected credentials → not confirmed + warning. A short list would be easier to scan than prose.

⚠️ These files are generated (see scripts/ and the Live docs section of CLAUDE.md), so any wording fix has to land in the CLI's long-description in kosli-dev/cli — not here. Non-blocking for this release PR.

credentials. Use `--debug` to see the status Jira returned per issue.

The `--jira-issue-fields` can be used to include fields from the jira issue. By default no fields
are included. `*all` will give all fields. Using `--jira-issue-fields "*all" --dry-run` will give you
Expand Down
4 changes: 2 additions & 2 deletions client_reference/kosli_attest_sonar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ exponential backoff between retries. Once the results are available they are att
2. Providing the Sonar project key and either the revision or the pull-request ID of the scan (plus the SonarQube server URL if relevant).
For branch scans: if running the Kosli CLI in some CI/CD pipeline, the revision is defaulted to the commit SHA. If you are running the command locally,
or have overriden the revision in SonarQube via parameters to the Sonar scanner, you can provide the correct revision using the `--sonar-revision` flag.
If the scan ran on a branch other than the project's main branch in SonarQube, also provide the branch name using the `--sonar-branch` flag:
SonarQube searches only the main branch unless it is told otherwise, so without it the scan cannot be found.
If the scan ran on a branch other than the project's main branch in SonarQube, also provide the branch name using the `--sonar-branch` flag.
SonarQube only searches the project's main branch unless told otherwise, so without this flag the scan cannot be found.
Comment on lines +29 to +30

@claude claude Bot Aug 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion — the rewrite here is an improvement (splitting the run-on into two sentences and dropping the dangling colon). Two pre-existing issues in the same paragraph that are worth fixing upstream while this text is being touched:

  • Line 28 (and lines 19, 85): overriden → overridden.
  • The sentence still says "the project's main branch in SonarQube" then repeats "the project's main branch" immediately after. Dropping the repetition would tighten it.

Generated file — fix in kosli-dev/cli, not in this PR.

For pull request scans: provide the pull-request ID using the `--pull-request` flag instead of the revision.
Kosli then finds the scan results for the specified project key and revision or pull-request ID.

Expand Down
2 changes: 1 addition & 1 deletion client_reference/kosli_begin_trail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ In other CI systems, set them explicitly to capture repository metadata.
<Tab title="GitHub">
View an example of the `kosli begin trail` command in GitHub.

In [this YAML file](https://github.com/cyber-dojo/runner/blob/76610271f641f1a5634465e97f880dfe019e515e/.github/workflows/main.yml#L78), which created [this Kosli Event](https://app.kosli.com/cyber-dojo/flows/runner-ci/trails/76610271f641f1a5634465e97f880dfe019e515e?attestation_id=1).
In [this YAML file](https://github.com/cyber-dojo/runner/blob/976b63e8001ec7441ebc7737ca69f620d47e7ffe/.github/workflows/main.yml#L78), which created [this Kosli Event](https://app.kosli.com/cyber-dojo/flows/runner-ci/trails/976b63e8001ec7441ebc7737ca69f620d47e7ffe?attestation_id=1).
</Tab>
<Tab title="GitLab">
View an example of the `kosli begin trail` command in GitLab.
Expand Down
2 changes: 1 addition & 1 deletion client_reference/kosli_create_attestation-type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ kosli create attestation-type customTypeName

```
</Accordion>
<Accordion title="create/update a custom attestation type with schema and ^jq^ evaluation rules">
<Accordion title="create/update a custom attestation type with schema and `jq` evaluation rules">
```shell
kosli create attestation-type customTypeName
--description "Attest that a person meets the age requirements."
Expand Down
2 changes: 1 addition & 1 deletion client_reference/kosli_create_flow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ You can specify flow parameters in flags.
<Tab title="GitHub">
View an example of the `kosli create flow` command in GitHub.

In [this YAML file](https://github.com/cyber-dojo/runner/blob/76610271f641f1a5634465e97f880dfe019e515e/.github/workflows/main.yml#L62)
In [this YAML file](https://github.com/cyber-dojo/runner/blob/976b63e8001ec7441ebc7737ca69f620d47e7ffe/.github/workflows/main.yml#L62)
</Tab>
<Tab title="GitLab">
View an example of the `kosli create flow` command in GitLab.
Expand Down
55 changes: 20 additions & 35 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#8212",
"snapshot_id": "aws-beta#8227",
"artifacts": [
{
"fingerprint": "2827829889b4acc994c3ffbfca250346d5f1f0ddf21847bcbe4864ae484ebe4f",
Expand All @@ -84,14 +84,6 @@ kosli diff snapshots aws-beta aws-prod --output=json
"commit_url": "https://github.com/cyber-dojo/custom-start-points/commit/b12a5c9b17023462d13e81381a69c7ef05f84dc2",
"instance_count": 1
},
{
"fingerprint": "36ad0020c6cd8716c1463808a185ca65379ec8151a9619d72549ee597d86accc",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/web:cbe481c@sha256:36ad0020c6cd8716c1463808a185ca65379ec8151a9619d72549ee597d86accc",
"most_recent_timestamp": 1787905359,
"flow": "web-ci",
"commit_url": "https://github.com/cyber-dojo/web/commit/cbe481c4b842f897e4e9e411cd78461a3a12a334",
"instance_count": 3
},
{
"fingerprint": "41aab2a45d074e91162ffde031d094118f0be3bdffa4d769ea24b415f5e8a9d6",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/exercises-start-points:f22a30e@sha256:41aab2a45d074e91162ffde031d094118f0be3bdffa4d769ea24b415f5e8a9d6",
Expand All @@ -108,14 +100,6 @@ kosli diff snapshots aws-beta aws-prod --output=json
"commit_url": "https://github.com/cyber-dojo/nginx/commit/9f52d31fe193e246154b5c7c51d0b0cd9e2072c8",
"instance_count": 1
},
{
"fingerprint": "596f149446bad7e8b1dfef6dbf4d036457339b984b22a05082c75ef2bde3e236",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/runner:7f0fb7b@sha256:596f149446bad7e8b1dfef6dbf4d036457339b984b22a05082c75ef2bde3e236",
"most_recent_timestamp": 1787895830,
"flow": "runner-ci",
"commit_url": "https://github.com/cyber-dojo/runner/commit/7f0fb7b049c2b9ceea5915b4fe780ca4090a289c",
"instance_count": 3
},
{
"fingerprint": "6440151a9419255a47d8f9fb0e610f5af3f555ad68fa84a50f950abae8b098fd",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/spooler:90c8d98@sha256:6440151a9419255a47d8f9fb0e610f5af3f555ad68fa84a50f950abae8b098fd",
Expand Down Expand Up @@ -159,7 +143,7 @@ kosli diff snapshots aws-beta aws-prod --output=json
]
},
"snappish2": {
"snapshot_id": "aws-prod#5285",
"snapshot_id": "aws-prod#5292",
"artifacts": [
{
"fingerprint": "1342e060fb8af6c34d004e474544d1472b940250eb0084f206c3d7bf9d78e2b5",
Expand All @@ -185,14 +169,6 @@ kosli diff snapshots aws-beta aws-prod --output=json
"commit_url": "https://github.com/cyber-dojo/differ/commit/108cccf9bccf9af5d455db66c250480b53cbecc7",
"instance_count": 1
},
{
"fingerprint": "6f394e0dccb59b852fa52ffa114fde8452280054c84de05b0627b1b0f18657bd",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/web:5e4b987@sha256:6f394e0dccb59b852fa52ffa114fde8452280054c84de05b0627b1b0f18657bd",
"most_recent_timestamp": 1786425419,
"flow": "web-ci",
"commit_url": "https://github.com/cyber-dojo/web/commit/5e4b9873df93525c041c386c06e0ab8fc36b6f33",
"instance_count": 3
},
{
"fingerprint": "8e965dda26af2d2e68032c25d68e792c85e0c7bd9814862de231bc4c6e935b81",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/custom-start-points:790d86b@sha256:8e965dda26af2d2e68032c25d68e792c85e0c7bd9814862de231bc4c6e935b81",
Expand Down Expand Up @@ -233,14 +209,6 @@ kosli diff snapshots aws-beta aws-prod --output=json
"commit_url": "https://github.com/cyber-dojo/exercises-start-points/commit/258b6d07d2b28ad5cb2ce6d29934997f72380f1a",
"instance_count": 1
},
{
"fingerprint": "f362f331cd56af641d03b9f647795f95c3a0d597a5e7ff659788f9dfec4fe8d9",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/runner:7661027@sha256:f362f331cd56af641d03b9f647795f95c3a0d597a5e7ff659788f9dfec4fe8d9",
"most_recent_timestamp": 1787665129,
"flow": "runner-ci",
"commit_url": "https://github.com/cyber-dojo/runner/commit/76610271f641f1a5634465e97f880dfe019e515e",
"instance_count": 3
},
{
"fingerprint": "ff871c3c8f4b5cfb60012bed1cd7f020b20f17fdabc2db0d8a5c77e75518fce0",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/spooler:dc7dea2@sha256:ff871c3c8f4b5cfb60012bed1cd7f020b20f17fdabc2db0d8a5c77e75518fce0",
Expand All @@ -255,7 +223,24 @@ kosli diff snapshots aws-beta aws-prod --output=json
"artifacts": []
},
"not-changed": {
"artifacts": []
"artifacts": [
{
"fingerprint": "01311f8b73bb61f65baabe680aa75ef9c0e6c5d1697ad81cfd89c89812de6fe9",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/runner:976b63e@sha256:01311f8b73bb61f65baabe680aa75ef9c0e6c5d1697ad81cfd89c89812de6fe9",
"most_recent_timestamp": 1788074312,
"flow": "runner-ci",
"commit_url": "https://github.com/cyber-dojo/runner/commit/976b63e8001ec7441ebc7737ca69f620d47e7ffe",
"instance_count": 3
},
{
"fingerprint": "36ad0020c6cd8716c1463808a185ca65379ec8151a9619d72549ee597d86accc",
"name": "244531986313.dkr.ecr.eu-central-1.amazonaws.com/web:cbe481c@sha256:36ad0020c6cd8716c1463808a185ca65379ec8151a9619d72549ee597d86accc",
"most_recent_timestamp": 1788074889,
"flow": "web-ci",
"commit_url": "https://github.com/cyber-dojo/web/commit/cbe481c4b842f897e4e9e411cd78461a3a12a334",
"instance_count": 3
}
]
}
}
```
Expand Down
6 changes: 3 additions & 3 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,9 +50,9 @@ kosli get environment aws-prod --output=json
"name": "aws-prod",
"type": "ECS",
"description": "The ECS cluster for production cyber-dojo",
"last_modified_at": 1788000298.4718719,
"last_reported_at": 1788000298.4718719,
"last_changed_at": 1787991898.5420277,
"last_modified_at": 1788098998.3881242,
"last_reported_at": 1788098998.3881242,
"last_changed_at": 1788074998.5362537,
"state": true,
"include_scaling": false,
"tags": {
Expand Down
Loading
Loading