Documentation/CLI reference

CLI reference

All commands and flags for the crawwwl CLI (v0.1.7).

Installation

npm install -g crawwwl
# or
pnpm add -g crawwwl

Commands

crawwwl audit

Run an audit on the current directory. Crawls source files, sends them to the API, and renders the report when complete.

FlagDescription
--scale quick | standard | deepAudit depth. quick: scanners only, no AI, always free. standard: scanners + AI validation. deep: full AI reasoning, recommended (default).
--ai / --no-aiOverride AI processing. AI is included automatically for standard and deep; use --no-ai to force scanner-only output.
--markdownWrite a Markdown report file (.crawwwl/report.md) alongside terminal output.
--no-markdownSuppress Markdown file output.
--fullShow all findings in terminal output, including low-severity ones that are collapsed by default.
crawwwl report

Fetch and display the most recent audit report for the current project without running a new audit.

FlagDescription
--markdownRe-export the last report as a Markdown file.
--fullShow all findings including low-severity ones.
crawwwl fix-check

Re-run the audit and compare results against the previous audit. Exits with code 1 if critical findings are present or if the score has dropped.

FlagDescription
--scale quick | standard | deepAudit scale for the re-run. Defaults to the scale of the previous audit.
crawwwl usage

Show your current balance and how much of it has been used. Opens your dashboard usage page when you want to top up.

crawwwl login

Authenticate with your crawwwl account. Required for deep audits. Opens a device auth flow in your browser.

Audit scales

quickInstant · Free

Runs all scanner categories. No AI processing. Good for fast iteration during development.

AI model: None

standard~10-30s · Paid

Scanners plus AI-generated explanations and recommendations for each finding. AI runs automatically, no extra prompt.

AI model: crawwwl AI (validation)

deep~1-3 min · Paid

Full AI reasoning. Understands project context, produces more nuanced insights, and is better at reducing false positives in larger projects. Default scale, recommended.

AI model: crawwwl AI (reasoning)

Output formats

Terminal (default)

Colour-coded report rendered directly to stdout. Scores, findings by severity, and top priorities.

Markdown (--markdown)

Writes crawwwl-report.md to the project root. Suitable for GitHub issues, Notion, or Confluence.

Full (--full)

By default, low-severity findings are collapsed. Pass --full to show everything.

Suppressing findings

Add // crawwwl-ignore on the line immediately above any code that triggers a finding to suppress it.

// crawwwl-ignore
<img src="/hero.png" />

// crawwwl-ignore
eval(userInput)

Suppressed lines are excluded from scoring and will not appear in audit reports. Use sparingly.

Environment

The CLI picks up auth credentials from ~/.crawwwl/config.json after running crawwwl login. No environment variables are required for CLI usage.

The CLI communicates with the crawwwl API at https://api.crawwwl.com. Outbound HTTPS on port 443 must be permitted in your network.