@index365/cli

@index365/cli

Website findings your coding agent can use.

The index365 CLI scans a URL and returns a score plus findings with stable IDs, evidence, and machine-readable remediation, from your terminal, CI, or an AI agent. It is a thin wrapper over the public /api/v1, so anything it does, your own agents can do too.

Two products ship on the CLI today: AI-Readiness (how well AI agents and AI search can read a site) and Marketing Signal (can demand find the site, trust the offer, act, and be measured). Website Security arrives when its report projection ships.

Install

npm install -g @index365/cli

Update later with npm i -g @index365/cli. The CLI shows an update box when a newer version is available.

Quickstart

index365 login                                # sign in (pick Browser or API key)
index365 scan https://acme.com                # resolve the project from the domain, wait, print the score
index365 scan https://acme.com --product marketing-signal
index365 scan https://acme.com --no-wait      # queue and print the runId (CI, async)
index365 runs list --project <id>             # runs, newest first
index365 report <runId>                       # compact agent-ready report (always JSON)
index365 report <runId> --save report.json    # full report: context plus every finding
index365 report --project <id>                # latest completed report for a project
index365 findings list --run <runId>          # triage findings
index365 findings get --run <runId> <findingId>   # full detail plus a copy-pasteable fix prompt
index365 scan local http://localhost:3000/ --project <id>   # score a local page before deploy
index365 --status                             # auth, org, plan, and credits at a glance

scan resolves the project from the url's domain automatically. No project for that domain yet? The error names the exact fix: index365 projects create --domain <domain>. Pass --project <id> to skip resolution. A scan waits by default and prints the final score; --no-wait queues it and prints the runId.

Signing in

index365 login asks how you want to sign in:

• Browser (default, recommended): opens your browser, you authorize on the dashboard, and the key is saved automatically (loopback + PKCE, so the secret never travels through a URL). Nothing to copy or paste.
• API key: paste a key created on the dashboard API Keys page (available on every plan, including Free).

Skip the menu with index365 login --web to go straight to the browser flow. For CI or headless machines, set INDEX365_API_KEY (preferred; it keeps the key out of shell history and process lists) or pass index365 login --key <key>.

Add --json to any command for machine-readable output. Keys live at ~/.config/index365/config.json (mode 0600); INDEX365_API_KEY overrides the file.

Migrating from 0.x

CLI 1.0 unified the command grammar around scan, runs, findings, and report. Every old spelling keeps working as a hidden alias for at least 90 days; it prints a one-line redirect note on stderr and then runs the new path.

Old (0.x)	New (1.0)
runs start --project <id> [--url <url>] [--wait]	scan <url> (waits by default; --no-wait to queue)
marketing run --project <id> [--wait]	scan <url> --product marketing-signal
marketing report --project <id>	report --project <id> --product marketing-signal
marketing findings --run <id> [--stage <s>]	findings list --run <id> [--stage <s>]
reports context <runId>	report <runId>
reports download <runId> [--output <file>]	report <runId> --save [file]
projects delete <id>	projects archive <id>

Projects

Project removal is reversible. projects archive preserves scan history and API keys, and projects restore reactivates the same row. Use projects list --status archived to find recoverable projects or --status all for every lifecycle state.

Exit codes

0 ok · 1 error · 2 usage · 3 auth · 4 not found · 5 quota/conflict/rate

Also available as index365 help exit-codes.

MCP

index365 mcp config   # prints ready-to-paste config for Claude Code, Codex, and Cursor

Docs

Full reference: https://index365.co/docs/developers/cli

License

MIT