CLI Reference
woof check
Purpose
CI/CD mode: Executes a strict scan and returns exit code 1 if violations are found.
Synopsis
Synopsiswoof check [PATH]
$ woof check [PATH]Flags
| Flag | Type | Description |
|---|---|---|
| [PATH] | argument | Designed for CI/CD pipelines. Runs a strict scan and returns a non-zero exit code (1) to fail the build if any secrets are detected.Default: . |
| -h, --help | boolean | Print help |
Exit Codes
- 0No secrets detected. Safe to proceed.
- 1One or more secrets were detected. Build failed.
- 2Invalid path or configuration error.
Examples
woof check
$ woof check[INFO] Indexing repository...[INFO] Sweep complete. Analyzed 200 files in 6ms.{"status":"failure","files_scanned":200,"threats":1}
Fails the CI/CD pipeline because a secret was found in the current directory.
woof check ./config
$ woof check ./config[INFO] Indexing repository...[INFO] Sweep complete. Analyzed 49 files in 56ms.{"status":"success","files_scanned":49,"threats":0}
Passes the pipeline check for the specific directory.
woof check /var/www
$ woof check /var/www[INFO] Indexing repository...[INFO] Sweep complete. Analyzed 0 files in 0ms.{"status":"failure","files_scanned":0,"threats":2}
Fails due to read permissions, which also safely stops the pipeline.
How is this guide?
Last updated on 09/11/2026