For the complete documentation index, see llms.txt. This page is also available as Markdown.

COS scan report

Use snyk cos scan report to return the report for a completed scan.

Usage

snyk cos scan report [<OPTIONS>]

Description

The snyk cos scan report command returns the report for a completed scan.

For a list of related commands, visit the Snyk COS help, snyk cos --help.

Exit codes

Possible exit codes and their meaning:

0: report downloaded 2: failure, report generation failed 3: failure, scan ID not found

Configure the Snyk CLI

You can use environment variables to configure the Snyk CLI and set variables to connect to the Snyk API. For more information, visit Configure the Snyk CLI.

Debug

Use the -d option to output the debug logs.

Options

--scan-id=<SCAN_ID>

Required. Specify the scan whose report you want to return.

Example:

--format=<FORMAT>

Specify the report format.

Allowed values: json, pdf

Default: json

Example:

--output-file=<FILE_PATH>

Write the report to the specified file path.

Example:

Last updated

Was this helpful?