Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(general): Add csv to output #5273

Merged
merged 1 commit into from
Jul 2, 2023
Merged

docs(general): Add csv to output #5273

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/2.Basics/CLI Command Reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ nav_order: 2
| `--external-checks-dir EXTERNAL_CHECKS_DIR` | Directory for custom checks to be loaded. Can be repeated |
| `--external-checks-git EXTERNAL_CHECKS_GIT` | GitHub URL of external checks to be added. you can specify a subdirectory after a double-slash //. Cannot be used together with --external-checks-dir |
| `-l, --list` | List checks |
| `-o, --output` {`cli`, `cyclonedx`, `cyclonedx_json`, `spdx`, `json`, `junitxml`, `github_failed_only`, `gitlab_sast`, `sarif`} | Report output format. Add multiple outputs by using the flag multiple times (-o sarif -o cli) |
| `-o, --output` {`cli`, `csv`, `cyclonedx`, `cyclonedx_json`, `spdx`, `json`, `junitxml`, `github_failed_only`, `gitlab_sast`, `sarif`} | Report output format. Add multiple outputs by using the flag multiple times (-o sarif -o cli) |
| `--output-file-path OUTPUT_FILE_PATH` | Name of the output folder to save the chosen output formats. Advanced usage: By using -o cli -o junitxml --output-file-path console,results.xml the CLI output will be printed to the console and the JunitXML output to the file results.xml. |
| `--output-bc-ids` | Print Bridgecrew platform IDs (BC...) instead of Checkov IDs (CKV...), if the check exists in the platform |
| `--include-all-checkov-policies` | When running with an API key, Checkov will omit any policies that do not exist in the Bridgecrew or Prisma Cloud platform, except for local custom policies loaded with the --external-check flags. Use this key to include policies that only exist in Checkov in the scan. Note that this will make the local CLI results different from the results you see in the platform. Has no effect if you are not using an API key. Use the --check option to explicitly include checks by ID even if they are not in the platform, without using this flag. |
Expand Down