Skip to content

Commit f2180c0

Browse files
committed
CM-63288 updated readme file
1 parent 5d9d0b3 commit f2180c0

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -802,6 +802,14 @@ cycode scan -t sca --stop-on-error path ~/home/git/codebase
802802
803803
This is useful in CI pipelines where a silent failure would produce an incomplete scan result. When `--stop-on-error` is triggered you can either fix the underlying issue or, for SCA restore failures specifically, add `--no-restore` to skip lockfile generation and scan direct dependencies only.
804804
805+
When `--stop-on-error` is used, the CLI distinguishes between scan errors and policy violations via exit codes:
806+
807+
| Exit code | Meaning |
808+
|-----------|---------|
809+
| `0` | Scan completed with no violations |
810+
| `1` | Scan completed and violations were found |
811+
| `2` | Scan aborted due to an error (only when `--stop-on-error` is set) |
812+
805813
### Repository Scan
806814
807815
A repository scan examines an entire local repository for any exposed secrets or insecure misconfigurations. This more holistic scan type looks at everything: the current state of your repository and its commit history. It will look not only for secrets that are currently exposed within the repository but previously deleted secrets as well.

0 commit comments

Comments
 (0)