Skip to content

Commit 98cac23

Browse files
AvishagpPeterSchafer
Avishagp
authored andcommitted
docs: synchronizing help from snyk/user-docs
1 parent cded8be commit 98cac23

File tree

6 files changed

+30
-18
lines changed

6 files changed

+30
-18
lines changed

help/cli-commands/code-test.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You can use environment variables to configure the Snyk CLI and set variables fo
2929

3030
Use the `-d` option to output the debug logs.
3131

32-
## Options for the code test subcommand
32+
## Options
3333

3434
### `--org=<ORG_ID>`
3535

@@ -47,6 +47,20 @@ Note that you can also use `--org=<orgslugname>`. The `ORG_ID` works in both the
4747

4848
For more information see the article [How to select the organization to use in the CLI](https://docs.snyk.io/snyk-cli/test-for-vulnerabilities/how-to-select-the-organization-to-use-in-the-cli)
4949

50+
### `--report`
51+
52+
**NEW** option: Share results with the Snyk Web UI.
53+
54+
**Feature availability**: This feature is currently in Closed Beta. To obtain access, contact your Snyk account representative.
55+
56+
This creates a project in your Snyk account with a snapshot of the current configuration issues or appends the snapshot to an existing project.
57+
58+
After using this option, log in to the Snyk website and view your projects to see the snapshot.
59+
60+
Example: `$ snyk code test --report` --project-name="PROJECT_NAME"
61+
62+
For more information see [Publishing CLI results to a Snyk Project](https://docs.snyk.io/scan-application-code/snyk-code/cli-for-snyk-code/publishing-cli-results-to-a-snyk-project-and-ignoring-cli-results#publishing-cli-results-to-a-snyk-project)
63+
5064
### `--json`
5165

5266
Print results on the console as a JSON data structure.

help/cli-commands/container-monitor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ For more information see [Detecting application vulnerabilities in container ima
124124

125125
### `--nested-jars-depth`
126126

127-
When `app-vulns` is enabled, use the `--nested-jars-depth` option to set how many levels of nested jars Snyk is to unpack. Depth must be a number.
127+
When `app-vulns` is enabled, use the `--nested-jars-depth=n` option to set how many levels of nested jars Snyk is to unpack. Depth must be a number.
128128

129129
### `--exclude-base-image-vulns`
130130

help/cli-commands/container-test.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,11 @@ Allow disabling scans for app vulnerabilities; in CLI versions 1.1090.0 (2023-01
116116

117117
In earlier releases, cannot be used with `--app-vulns`.
118118

119-
For more information see [Detecting application vulnerabilities in container images](https://docs.snyk.io/products/snyk-container/getting-around-the-snyk-container-ui/detecting-application-vulnerabilities-in-container-images)
119+
For more information, see [Detecting application vulnerabilities in container images](https://docs.snyk.io/products/snyk-container/getting-around-the-snyk-container-ui/detecting-application-vulnerabilities-in-container-images)
120120

121121
### `--nested-jars-depth`
122122

123-
When `app-vulns` is enabled, use the `--nested-jars-depth` option to set how many levels of nested jars Snyk is to unpack. Depth must be a number.
123+
When `app-vulns` is enabled, use the `--nested-jars-depth=n` option to set how many levels of nested jars Snyk is to unpack. Depth must be a number.
124124

125125
### `--exclude-base-image-vulns`
126126

@@ -156,4 +156,8 @@ Specify a password to use when connecting to a container registry. This is ignor
156156

157157
`$ snyk container test app:latest --file=Dockerfile --policy-path=path/to/.snyk`
158158

159-
For more information and examples see [Advanced Snyk Container CLI usage](https://docs.snyk.io/snyk-container/snyk-cli-for-container-security/advanced-snyk-container-cli-usage)
159+
### Refer to a container image by its digest
160+
161+
`$ snyk container test app@sha256:17cb37098f0efb819c075eea4ff2a495be909a396e86ece317a6e3a8968e025c --file=Dockerfile`
162+
163+
For more information and examples, see [Advanced Snyk Container CLI usage](https://docs.snyk.io/snyk-container/snyk-cli-for-container-security/advanced-snyk-container-cli-usage)

help/cli-commands/iac-test.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,9 @@ Set or override the remote URL for the repository.
149149

150150
**NEW** option: Share results with the Snyk Web UI.
151151

152-
This creates a project in your Snyk account with a snapshot of the current configuration issues. After using this option, log in to the Snyk website and view your projects to see the monitor.
152+
This creates a project in your Snyk account with a snapshot of the current configuration issues or appends the snapshot to an existing project.
153+
154+
After using this option, log in to the Snyk website and view your projects to see the snapshot.
153155

154156
Example: `$ snyk iac test --report`
155157

help/cli-commands/ignore.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ Human-readable `<REASON>` to ignore this issue.
7272

7373
Default: none
7474

75+
**Note**: Not supported for Snyk Code.
76+
7577
### `--policy-path=<PATH_TO_POLICY_FILE>`
7678

7779
Path to a `.snyk` policy file to pass manually.

help/cli-commands/sbom.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -87,18 +87,8 @@ Optional. Instruct the CLI to autodetect a package manager manifest file to use
8787

8888
### Create an SPDX 2.3 JSON document for an unmanaged software project
8989

90-
```bash
91-
$ snyk sbom --unmanaged --format=spdx2.3+json
92-
```
90+
`$ snyk sbom --unmanaged --format=spdx2.3+json`
9391

9492
### Create a CycloneDX XML document for a Maven project
9593

96-
```
97-
$ snyk sbom --file=pom.xml --format=cyclonedx1.4+xml
98-
```
99-
100-
### **Create a CycloneDX JSON document and scan using bomber and Snyk**
101-
102-
<pre class="language-bash"><code class="lang-bash"><strong>$ snyk sbom --format=cyclonedx1.4+json --file=go.mod > /tmp/sbom.cdx.json &#x26;&#x26; \
103-
</strong><strong> bomber scan --provider snyk --token $SNYK_API_TOKEN /tmp/sbom.cdx.json
104-
</strong></code></pre>
94+
`$ snyk sbom --file=pom.xml --format=cyclonedx1.4+xml`

0 commit comments

Comments
 (0)