From ac4736af56e81c6b64bffa481352eb05d4ea1a39 Mon Sep 17 00:00:00 2001 From: Team CLI Bot Date: Mon, 29 Jun 2026 10:36:03 +0000 Subject: [PATCH] docs: synchronizing help from snyk/user-docs --- help/cli-commands/README.md | 6 +----- help/cli-commands/aibom.md | 2 +- help/cli-commands/code-test.md | 16 ++++++++++++++-- help/cli-commands/container-test.md | 2 +- help/cli-commands/iac-test.md | 4 ++-- help/cli-commands/ignore.md | 4 ++-- help/cli-commands/log4shell.md | 2 +- help/cli-commands/sbom-test.md | 2 +- help/cli-commands/test.md | 4 ++-- 9 files changed, 25 insertions(+), 17 deletions(-) diff --git a/help/cli-commands/README.md b/help/cli-commands/README.md index cab7bea1da..2eff6aa28a 100644 --- a/help/cli-commands/README.md +++ b/help/cli-commands/README.md @@ -50,16 +50,12 @@ Generate or test an SBOM document in ecosystems supported by Snyk. ### [`snyk aibom`](aibom.md) -Generates an AIBOM for a local software project that is written in Python, to understand what AI models, datasets, tools, and so on are used in that project. +Generates an AIBOM for a local software project written in Python, Java, JavaScript, or Go, to understand what AI models, datasets, tools, and so on are used in that project. ### [`snyk aibom test`](aibom-test.md) Generates an AI-BOM and tests it against your tenant's policies, returning all resulting issues. -### [`snyk redteam`](redteam.md) - -Runs a red teaming scan against AI targets and reports vulnerabilities. - ### [`snyk log4shell`](log4shell.md) Find Log4Shell vulnerability. diff --git a/help/cli-commands/aibom.md b/help/cli-commands/aibom.md index d017bc9186..25c674c0ce 100644 --- a/help/cli-commands/aibom.md +++ b/help/cli-commands/aibom.md @@ -13,7 +13,7 @@ ## Description -The `snyk aibom` command generates an AI-BOM for a local software Project that is written in Python. You can use the `snyk aibom` command to identify AI models, datasets, and map the AI supply chain, including connections to external tools and services using the Model Context Protocol (MCP). +The `snyk aibom` command generates an AI-BOM for a local software Project written in Python, Java, JavaScript, or Go. You can use the `snyk aibom` command to identify AI models, datasets, and map the AI supply chain, including connections to external tools and services using the Model Context Protocol (MCP). The supported format is CycloneDX v1.6 (JSON). diff --git a/help/cli-commands/code-test.md b/help/cli-commands/code-test.md index 4dc5b21891..7f441c0924 100644 --- a/help/cli-commands/code-test.md +++ b/help/cli-commands/code-test.md @@ -13,7 +13,7 @@ The `snyk code test` command tests source code for any known security issues (St Possible exit codes and their meaning: **0**: success (scan completed), no vulnerabilities found\ -**1**: action_needed (scan completed), vulnerabilities found\ +**1**: action\_needed (scan completed), vulnerabilities found\ **2**: failure, try to re-run the command. Use `-d` to output the debug logs.\ **3**: failure, no supported projects detected @@ -43,6 +43,18 @@ Example: `$ snyk code test --report` Example: `$ snyk code test --report --project-name=my-project` +### `--project-tags=[,...]` + +Use this option with the `--report` option. + +Set one or more project tags for your project. Specify tags as comma-separated `key=value` pairs. + +Example: `--project-tags=department=finance,team=alpha` + +To clear all project tags, set `--project-tags=`. + +For more information about valid characters, visit [Project tags](https://app.gitbook.com/s/BJO0IZx7zB6bOkotxQP2/scan-with-snyk/snyk-projects/project-tags). + ### `--target-name=` This can be used in combination with the `--report` option. @@ -111,7 +123,7 @@ Example: `$ snyk code test --sarif` ### `--sarif-file-output=` -Save test output in SARIF format directly to the \ file, regardless of whether or not you use the `--sarif` option. +Save test output in SARIF format directly to the \ file, regardless of whether or not you use the `--sarif` option. Use to display the human-readable test output using stdout and, at the same time, save the SARIF format output to a file.\ \ diff --git a/help/cli-commands/container-test.md b/help/cli-commands/container-test.md index e6aa01f578..a0f3f997a6 100644 --- a/help/cli-commands/container-test.md +++ b/help/cli-commands/container-test.md @@ -13,7 +13,7 @@ The `snyk container test` command tests container images for any known vulnerabi Possible exit codes and their meaning: **0**: success (scan completed), no vulnerabilities found\ -**1**: action_needed (scan completed), vulnerabilities found\ +**1**: action\_needed (scan completed), vulnerabilities found\ **2**: failure, try to re-run command. Use `-d` to output the debug logs.\ **3**: failure, no supported projects detected diff --git a/help/cli-commands/iac-test.md b/help/cli-commands/iac-test.md index 3cf80f378c..09dbe3a08c 100644 --- a/help/cli-commands/iac-test.md +++ b/help/cli-commands/iac-test.md @@ -17,7 +17,7 @@ For more information see [Snyk CLI for IaC](https://docs.snyk.io/snyk-cli/scan-a Possible exit codes and their meaning: **0**: success (scan completed), no vulnerabilities found\ -**1**: action_needed (scan completed), vulnerabilities found\ +**1**: action\_needed (scan completed), vulnerabilities found\ **2**: failure, try to re-run the command. Use `-d` to output the debug logs.\ **3**: failure, no supported projects detected @@ -85,7 +85,7 @@ Return results in SARIF format. ### `--sarif-file-output=` -Save test output in SARIF format directly to the \ file, regardless of whether or not you use the `--sarif` option. +Save test output in SARIF format directly to the \ file, regardless of whether or not you use the `--sarif` option. This is especially useful if you want to display the human-readable test output using stdout and at the same time save the SARIF format output to a file. diff --git a/help/cli-commands/ignore.md b/help/cli-commands/ignore.md index 3174174bd6..f47e624430 100644 --- a/help/cli-commands/ignore.md +++ b/help/cli-commands/ignore.md @@ -146,7 +146,7 @@ $ snyk ignore --id='SNYK-JS-PATHPARSE-1077067' --expiry='2021-01-10' --path='nyc In this example, `snyk iac test` on Windows returned a Path containing single quotes and a File specification containing back slashes: Rule: [https://security.snyk.io/rules/cloud/SNYK-CC-TF-118](https://security.snyk.io/rules/cloud/SNYK-CC-TF-118)\ -Path: resource > aws_iam_role\[OrganizationAccountAccessRole] > assume_role_policy\['Statement']\[0]\ +Path: resource > aws\_iam\_role\[OrganizationAccountAccessRole] > assume\_role\_policy\['Statement']\[0]\ File: terraform\environment\com\iam.tf The corresponding `snyk ignore` command would be: @@ -160,7 +160,7 @@ $ snyk ignore --id=SNYK-CC-TF-118 --path="terraform\environment\com\iam.tf > res In this example, `snyk iac test` on Linux or Mac OS returned a Path containing single quotes and a File specification containing forward slashes: Rule: [https://security.snyk.io/rules/cloud/SNYK-CC-TF-118](https://security.snyk.io/rules/cloud/SNYK-CC-TF-118)\ -Path: resource > aws_iam_role\[OrganizationAccountAccessRole] > assume_role_policy\['Statement']\[0]\ +Path: resource > aws\_iam\_role\[OrganizationAccountAccessRole] > assume\_role\_policy\['Statement']\[0]\ File: terraform/environment/com/iam.tf The corresponding `snyk ignore` command would be: diff --git a/help/cli-commands/log4shell.md b/help/cli-commands/log4shell.md index e60fa8818b..a8d33a774b 100644 --- a/help/cli-commands/log4shell.md +++ b/help/cli-commands/log4shell.md @@ -23,7 +23,7 @@ See the Maven options section of the [test command help](test.md); `snyk test -- Possible exit codes and their meaning: **0**: success (scan completed), Log4Shell not found\ -**1**: action_needed (scan completed), Log4Shell found\ +**1**: action\_needed (scan completed), Log4Shell found\ **2**: failure, try to re-run the command. Use `-d` to output the debug logs. ## Debug diff --git a/help/cli-commands/sbom-test.md b/help/cli-commands/sbom-test.md index d33e70ca3d..68ed1cd4a5 100644 --- a/help/cli-commands/sbom-test.md +++ b/help/cli-commands/sbom-test.md @@ -15,7 +15,7 @@ The `snyk sbom test` command checks SBOM files for vulnerabilities in open-sourc Possible exit codes and their meaning: **0**: success (scan completed), no vulnerabilities found\ -**1**: action_needed (scan completed), vulnerabilities found\ +**1**: action\_needed (scan completed), vulnerabilities found\ **2**: failure, try to re-run the command ## Configure the Snyk CLI diff --git a/help/cli-commands/test.md b/help/cli-commands/test.md index b0678e5e98..6ac73b2c5f 100644 --- a/help/cli-commands/test.md +++ b/help/cli-commands/test.md @@ -15,7 +15,7 @@ The `snyk test` command checks projects for open-source vulnerabilities and lice Possible exit codes and their meaning: **0**: success (scan completed), no vulnerabilities found\ -**1**: action_needed (scan completed), vulnerabilities found\ +**1**: action\_needed (scan completed), vulnerabilities found\ **2**: failure, try to re-run the command. Use `-d` to output the debug logs.\ **3**: failure, no supported projects detected @@ -210,7 +210,7 @@ Return results in SARIF format. ### `--sarif-file-output=` -Save test output in SARIF format directly to the \ file, regardless of whether or not you use the `--sarif` option. +Save test output in SARIF format directly to the \ file, regardless of whether or not you use the `--sarif` option. This is especially useful if you want to display the human-readable test output using stdout and at the same time save the SARIF format output to a file.