CLI

The crawrix binary mirrors the web product: audits, findings, GEO readiness, and optional GitHub PRs — with diffs on an approval card before anything writes to disk.

Install

Node.js 20 or later. The binary is always named crawrix.

npm / pnpm / bun

npm i -g crawrix
# or
pnpm add -g crawrix
# or
bun add -g crawrix

crawrix --version
crawrix --help

One-shot without a global install

npx crawrix audit --json

Authenticate

Three paths — pick one:

  • Hosted (recommended with a crawrix account) — no provider key to manage. Model calls route through your account.
  • BYOK via Vercel AI Gateway — one key, full provider/model catalogue.
  • BYOK direct — Anthropic or OpenAI key for that provider's models only.

Hosted device flow

crawrix login --hosted
# Approve the code in the browser while signed in
crawrix whoami

BYOK

crawrix login --provider anthropic   # pastes sk-ant-…
crawrix login --provider openai      # pastes sk-…
crawrix login --provider gateway     # Vercel AI Gateway key

First audit

  1. Enter a repo

    Any modern JS framework works (Next.js, Astro, SvelteKit, Remix, Nuxt, and more). Detection is automatic — no flag needed.

    cd ~/code/my-nextjs-app
  2. Initialize the workspace

    Creates .crawrix/ for audits, findings, and reports, and adds it to .gitignore.

    crawrix init
  3. Open the REPL or run a one-shot audit

    Interactive

    crawrix
    # then: audit this repo for SEO issues

    Non-interactive / CI

    crawrix audit --json

Approvals

Write tools — edit, write, delete, and open PR — pause for approval. The diff on the card is display-only; the tool re-reads the file on execute so a mid-flight change fails loudly instead of applying stale content.

  • Normal mode — you approve each write.
  • Auto mode — auto-approves safe file edits; deletes and PRs still need a human.
  • Plan mode — research only; every write is declined.

Cycle modes with shift+tab, or /plan / /auto. --yes raises the risk ceiling for unattended runs; it never opens a PR without a TTY.

Useful commands

crawrix
Interactive REPL (requires a TTY).
crawrix audit
Non-interactive audit; add --json for machines.
crawrix findings list
Index of findings, severity-sorted.
crawrix whoami
Show the signed-in identity / key slots.
crawrix sync
Push local artefacts to the hosted dashboard.
crawrix login --hosted
Device-flow login to your account.