UNPKG

snyk

Version:

snyk library and cli utility

snyk/snyk

79 lines (41 loc) • 3.03 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# Code test ## Usage `snyk code test [<OPTIONS>] [<PATH>]` ## Description The `snyk code test` command tests for any known security issues using Static Code Analysis. For more information see [Using Snyk Code via the CLI](../../products/snyk-code/cli-for-snyk-code/). For instructions on ignoring issues with `snyk code test` see [Excluding directories and files from the Snyk Code CLI test](../../products/snyk-code/cli-for-snyk-code/excluding-directories-and-files-from-the-snyk-code-cli-test.md). ## Exit codes Possible exit codes and their meaning: **0**: success, no vulnerabilities found\ **1**: action_needed, vulnerabilities found\ **2**: failure, try to re-run command\ **3**: failure, no supported projects detected ## Configure the Snyk CLI You can use environment variables to configure the Snyk CLI and set variables for connecting with the Snyk API; see [Configure the Snyk CLI](https://docs.snyk.io/features/snyk-cli/configure-the-snyk-cli) ## Debug Use the `-d` option to output the debug logs. ## Options for the code test subcommand ### `--org=<ORG_ID>` Specify the `<ORG_ID>`to run Snyk commands tied to a specific organization. The `<ORG_ID>` influences private test limits. If you have multiple organizations, you can set a default from the CLI using: `$ snyk config set org=<ORG_ID>` Set a default to ensure all newly tested projects are tested under your default organization. If you need to override the default, use the `--org=<ORG_ID>` option. Default: `<ORG_ID>` that is the current preferred organization in your [Account settings](https://app.snyk.io/account) Note that you can also use `--org=<orgslugname>`. The `ORG_ID` works in both the CLI and the API. The organization slug name works in the CLI, but not in the API. For more information see the article [How to select the organization to use in the CLI](https://support.snyk.io/hc/en-us/articles/360000920738-How-to-select-the-organization-to-use-in-the-CLI) ### `--json` Print results on the console as a JSON data structure. Example: `$ snyk code test --json` ### `--json-file-output=<OUTPUT_FILE_PATH>` Save test output as a JSON data structure directly to the specified file, regardless of whether or not you use the `--json` option. Use to display the human-readable test output using stdout and at the same time save the JSON data structure output to a file. Example: `$ snyk code test --json-file-output=vuln.json` ### `--sarif` Return results in SARIF format. Example: `$ snyk code --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. Use to display the human-readable test output using stdout and at the same time save the SARIF format output to a file. ### `--severity-threshold=<low|medium|high|critical>` Report only vulnerabilities at the specified level or higher. Note that the Snyk Code configuration issues do not currently use the `critical` severity level.