CLI

CLI usage

The slate command creates or reuses a target for the domain you pass, starts a scan, and optionally waits for results.

Basic scan

slate example.com

Creates a target for https://example.com (scheme added if missing), triggers a scan, and prints the scan id.

Wait for results

slate example.com --wait

Polls until the scan completes or fails, then prints findings in the terminal.

JSON output

slate example.com --wait --json

Emits machine-readable JSON for scripting and CI parsers. Includes scan status, progress fields, and findings (severity, name, url).

What happens under the hood

  1. POST /api/v1/targets — create or return existing target for the URL
  2. POST /api/v1/scans — start scan (requires credit)
  3. GET /api/v1/scans/:id — poll status and findings when using --wait

See Scans API for response shapes.

Flags

  • --wait — block until complete
  • --json — JSON output