From ab1a3ce2e8056659a2b689eea37ba03b742c7b71 Mon Sep 17 00:00:00 2001 From: Kaspar Lyngsie Date: Thu, 2 Nov 2023 11:05:00 +0100 Subject: [PATCH] chore: update README.md --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 51047cb..e217b31 100644 --- a/README.md +++ b/README.md @@ -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