Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@dotkas
dotkas committed Nov 2, 2023
1 parent dc12b28 commit ab1a3ce
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,24 +95,24 @@ jobs:
Full reference docs https://circleci.com/orbs/registry/orb/snyk/snyk
| Parameter | Description | Required | Default | Type |
|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|----------|------------|--------------------------------|
| command | The CLI command (i.e. "test", "iac test") to execute | no | test | string |
| monitor-command | The CLI monitor command (i.e. "monitor", "container monitor") to execute | no | monitor | string |
| token-variable | Name of env var containing your Snyk API token | no | SNYK_TOKEN | env_var_name |
| severity-threshold | Only report vulnerabilities of provided level or higher (low/medium/high/critical) | no | low | low \| med \| high \| critical |
| fail-on-issues | This specifies if builds should be failed or continued based on issues found by Snyk | no | true | boolean |
| monitor-on-build | Take a current application dependencies snapshot for continuous monitoring by Snyk, if test was succesful | no | true | boolean |
| target-file | The path to the manifest file to be used by Snyk. Should be provided if non-standard | no | - | string |
| docker-image-name | The image name, if scanning a container image | no | - | string |
| organization | The Snyk Organization ID (see Organization-level Settings tab in the Snyk UI) under which this project should be tested and monitored. | no | - | string |
| project | A custom name for the Snyk project to be created on snyk.io | no | - | string |
| additional-arguments | Refer to the Snyk CLI help page for information on additional arguments. These are passed to all `snyk` commands. | no | - | string |
| additional-monitor-arguments | Refer to the Snyk CLI help page for information on additional arguments. These are passed to `snyk monitor`. | no | - | string |
| os | The CLI OS version to download | no | linux | linux \| macos \| alpine |
| install-alpine-dependencies | For the alpine CLI, should extenral dependencies be installed | no | true | boolean |
| no-output-timeout | Elapsed time the command can run without output. The default is 10 minutes | no | 10m | string |
| no-cache | Disable caching the Snyk CLI | no | false | boolean |
| Parameter | Description | Required | Default | Type |
|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|----------|------------|-----------------------------------------|
| command | The CLI command (i.e. "test", "iac test") to execute | no | test | string |
| monitor-command | The CLI monitor command (i.e. "monitor", "container monitor") to execute | no | monitor | string |
| token-variable | Name of env var containing your Snyk API token | no | SNYK_TOKEN | env_var_name |
| severity-threshold | Only report vulnerabilities of provided level or higher (low/medium/high/critical) | no | low | low \| med \| high \| critical |
| fail-on-issues | This specifies if builds should be failed or continued based on issues found by Snyk | no | true | boolean |
| monitor-on-build | Take a current application dependencies snapshot for continuous monitoring by Snyk, if test was succesful | no | true | boolean |
| target-file | The path to the manifest file to be used by Snyk. Should be provided if non-standard | no | - | string |
| docker-image-name | The image name, if scanning a container image | no | - | string |
| organization | The Snyk Organization ID (see Organization-level Settings tab in the Snyk UI) under which this project should be tested and monitored. | no | - | string |
| project | A custom name for the Snyk project to be created on snyk.io | no | - | string |
| additional-arguments | Refer to the Snyk CLI help page for information on additional arguments. These are passed to all `snyk` commands. | no | - | string |
| additional-monitor-arguments | Refer to the Snyk CLI help page for information on additional arguments. These are passed to `snyk monitor`. | no | - | string |
| os | The CLI OS version to download | no | linux | linux \| linux-arm64 \| macos \| alpine |
| install-alpine-dependencies | For the alpine CLI, should extenral dependencies be installed | no | true | boolean |
| no-output-timeout | Elapsed time the command can run without output. The default is 10 minutes | no | 10m | string |
| no-cache | Disable caching the Snyk CLI | no | false | boolean |

## Screenshots

Expand Down

0 comments on commit ab1a3ce

Please sign in to comment.