CLI Reference
woof scan
Purpose
Scans a target directory for exposed cryptographic secrets and tokens.
Synopsis
Synopsiswoof scan [PATH]
$ woof scan [PATH]Flags
| Flag | Type | Description |
|---|---|---|
| [PATH] | argument | Recursively searches the specified directory for high-entropy tokens, private keys, and hardcoded credentials.Default: . |
| -h, --help | boolean | Print help |
Common Mistakes
- Using scan in a CI/CD pipeline and expecting it to fail the build (use woof check instead).
Exit Codes
- 0Scan completed successfully. Secrets may or may not have been found (use check for strict CI/CD failure).
- 2Invalid path provided or insufficient permissions to read the directory.
Examples
woof scan
$ woof scanScanning .Found 2 potential secrets.
Scans the current directory (default).
woof scan ./src
$ woof scan ./srcScanning ./src✓ Clean. No secrets found.
Scans only the specified ./src directory.
woof scan ../backend
$ woof scan ../backendScanning ../backend[!] Found 1 AWS Access Key.
Scans a relative directory outside the current working path.
How is this guide?
Last updated on 09/11/2026