Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 1 addition & 5 deletions help/cli-commands/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion help/cli-commands/aibom.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
16 changes: 14 additions & 2 deletions help/cli-commands/code-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -43,6 +43,18 @@ Example: `$ snyk code test --report`

Example: `$ snyk code test --report --project-name=my-project`

### `--project-tags=<TAG>[,<TAG>...]`

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=<TARGET_NAME>`

This can be used in combination with the `--report` option.
Expand Down Expand Up @@ -111,7 +123,7 @@ Example: `$ snyk code test --sarif`

### `--sarif-file-output=<OUTPUT_FILE_PATH>`

Save test output in SARIF format directly to the \<OUTPUT_FILE_PATH> file, regardless of whether or not you use the `--sarif` option.&#x20;
Save test output in SARIF format directly to the \<OUTPUT\_FILE\_PATH> 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.\
\
Expand Down
2 changes: 1 addition & 1 deletion help/cli-commands/container-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions help/cli-commands/iac-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -85,7 +85,7 @@ Return results in SARIF format.

### `--sarif-file-output=<OUTPUT_FILE_PATH>`

Save test output in SARIF format directly to the \<OUTPUT_FILE_PATH> file, regardless of whether or not you use the `--sarif` option.
Save test output in SARIF format directly to the \<OUTPUT\_FILE\_PATH> 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.

Expand Down
4 changes: 2 additions & 2 deletions help/cli-commands/ignore.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion help/cli-commands/log4shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion help/cli-commands/sbom-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions help/cli-commands/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -210,7 +210,7 @@ Return results in SARIF format.

### `--sarif-file-output=<OUTPUT_FILE_PATH>`

Save test output in SARIF format directly to the \<OUTPUT_FILE_PATH> file, regardless of whether or not you use the `--sarif` option.
Save test output in SARIF format directly to the \<OUTPUT\_FILE\_PATH> 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.

Expand Down