Skip to content

Commit

Permalink
docs: synchronizing help from snyk/user-docs (#4969)
Browse files Browse the repository at this point in the history
Co-authored-by: Avishagp <[email protected]>
  • Loading branch information
github-actions[bot] and Avishagp authored Dec 20, 2023
1 parent b2ab4c0 commit 0b6743c
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 6 deletions.
4 changes: 2 additions & 2 deletions help/cli-commands/container-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Possible exit codes and their meaning:

**0**: success (scan completed), no vulnerabilities found\
**1**: action_needed (scan completed), vulnerabilities found\
**2**: failure, try to re-run command\
**2**: failure, try to re-run command. Use `-d` to output the debug logs.\
**3**: failure, no supported projects detected

## Configure the Snyk CLI
Expand Down Expand Up @@ -96,7 +96,7 @@ Report only vulnerabilities at the specified level or higher.
Fail only when there are vulnerabilities that can be fixed.

- `all`: fail when there is at least one vulnerability that can be either upgraded or patched.
- `upgradable`: fail when there is at least one vulnerability that can be upgraded.
- `upgradable`: fail when there is at least one vulnerability for which Snyk has a computed remediation available.

To fail on any Snyk discoverable vulnerability (the default behavior), do not use the `--fail-on` option. If vulnerabilities do not have a Snyk-computed fix and this option is being used, tests pass.

Expand Down
2 changes: 0 additions & 2 deletions help/cli-commands/iac-describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,6 @@ Use filter rules.

Filter rules allow you to build a JMESPath expression to include or exclude a set of resources from the report.

To filter on resource attributes, deep mode must be enabled. Deep mode is enabled by default for `--all` and `--only-managed`. To enable deep mode while using `--only-unmanaged`, use the `--deep` option.

For more information, see [Filter results](https://docs.snyk.io/products/snyk-infrastructure-as-code/detect-drift-and-manually-created-resources/filter-results)

### `--strict`
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 @@ -213,8 +213,8 @@ Report only vulnerabilities at the specified level or higher.
Fail only when there are vulnerabilities that can be fixed. Use one of the values as follows:

- `all`: Use to fail when there is at least one vulnerability that can be either upgraded or patched.
- `upgradable`: Use to fail when there is at least one vulnerability that can be upgraded.
- `patchable`: Use to fail when there is at least one vulnerability that can be patched. Note that when you use patchable, the test will also fail if at least one vulnerability can be patched and other vulnerabilities found can be upgraded.
- `upgradable`: Use to fail when there is at least one vulnerability for which Snyk has a computed remediation available.
- `patchable`: Use to fail when there is at least one vulnerability that can be patched. Note that when you use `patchable`, the test will also fail if at least one vulnerability can be patched and other vulnerabilities found have a computed remediation available.

To fail on any Snyk-discoverable vulnerability (the default behavior), do not use the `--fail-on` option. If vulnerabilities do not have a Snyk-computed fix and this option is being used, tests pass.

Expand Down

0 comments on commit 0b6743c

Please sign in to comment.