Skip to content

Commit

Permalink
docs: add exit code scan documentation (#1199)
Browse files Browse the repository at this point in the history
  • Loading branch information
gmontard authored and gotbadger committed Aug 22, 2023
1 parent 3d10d3e commit 6853afd
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/guides/configure-scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,14 @@ Depending on how you're using Bearer CLI, you may want to limit the severity lev
bearer scan . --severity critical,high
```

## Force a given exit code for the scan command

If you want to force a successful exit code even when findings are reported, use the `--exit-code` flag and set it to 0. It's particularly useful if you want to perform a scan and report findings without failing your CI or CD pipeline.

```bash
bearer scan . --exit-code 0
```

## Change the output format

Each [report type](/explanations/reports/) has a default output format, but in general you're able to also select between `json` and `yaml` with the `--format` flag.
Expand Down

0 comments on commit 6853afd

Please sign in to comment.