Skip to main content

​
stackprobe audit

Run all checks on the current project. 
stackprobe audit [options]

​
Options

​
--json

Type: boolean
Default: false Output results as JSON instead of the human-readable format. Useful for CI pipelines and automated processing. 
stackprobe audit --json
Use cases:
  • Parsing results in CI/CD workflows
  • Integration with custom tooling
  • Storing audit results in structured format

​
--fix

Type: boolean
Default: false
Status: Coming soon Attempt to auto-fix issues where possible. 
stackprobe audit --fix
The --fix flag is currently in development and not yet functional.

​
--only <checks>

Type: string
Format: Comma-separated list
Available checks: deps, env, license, engine, circular Run only specific checks instead of all available checks. 
stackprobe audit --only deps,env
Examples: 
# Run only dependency check
stackprobe audit --only deps

# Run multiple specific checks
stackprobe audit --only deps,env,license

# Combine with JSON output
stackprobe audit --only circular --json

​
Available Checks

Check NameDescription
licenseValidates project license configuration
envChecks environment variable setup
depsAudits project dependencies
engineVerifies Node.js engine compatibility
circularDetects circular dependencies

​
Usage Examples

Basic audit: 
stackprobe audit
JSON output for CI: 
stackprobe audit --json
Run specific checks: 
stackprobe audit --only deps,env
Combine options: 
stackprobe audit --only circular --json

​
Configuration

The --only flag can be combined with the ignore option in your configuration file. When both are present, --only takes precedence and the ignore list is not applied. See the Configuration page for more details on configuring which checks run by default.

Build docs developers (and LLMs) love

Get started for freeTalk to us