Skip to content

CLI Reference

klyrek crawl <url> [options]

  -o, --output DIR        Output directory for the report
  --format FMT            markdown | json | html | all  (default: markdown)
  --max-pages N           default: 100
  --max-depth N           default: 3
  --rate-limit N          requests/sec per host, default: 5.0
  --include-host PATTERN  additional authorized host/wildcard (repeatable)
  --user-agent STRING
  --skip-tech / --skip-headers / --skip-api / --skip-auth / --skip-js / --skip-assets
  -v, --verbose

klyrek dashboard <path>   # open the Textual TUI for a saved --format json scan

Examples

Crawl the sandbox, exporting every format at once:

klyrek crawl https://shop.sandbox.klyrek.com --include-host "*.sandbox.klyrek.com" --format all

Skip the modules you don't need for a faster, narrower pass:

klyrek crawl https://shop.sandbox.klyrek.com --skip-assets --skip-js --max-depth 2

Open the dashboard on a saved JSON scan:

klyrek crawl https://shop.sandbox.klyrek.com --format json -o ./scans
klyrek dashboard ./scans/shop.sandbox.klyrek.com_20260706T080223Z.json

See Authorization & Scope for exactly what --include-host does and why it's needed for multi-subdomain targets like the sandbox.