@index365/cli

@index365/cli

Run index365 website audits from your terminal, CI, or an AI agent. The CLI is a thin wrapper over the public /api/v1, so anything it does, your own agents can do too.

index365 runs two audits: 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). Each run produces a score plus findings with stable IDs, evidence, and machine-readable remediation.

Install

npm install -g @index365/cli

Update to the latest version later with npm i -g @index365/cli@latest. The CLI also prints a one-line notice when a newer version is available.

Quickstart

index365 login            # sign in (pick Browser or API key)
index365 whoami           # which account/org this machine is signed in as
index365 doctor           # diagnose auth, version, and config (--fix applies safe fixes)
index365 projects list --status active    # find an active projectId
index365 projects archive <id> --confirm <domain> # reversible removal
index365 projects restore <id>            # reactivate the same project and history
index365 runs start --project <id> --wait   # run an AI-readiness audit, wait for the score
index365 marketing run --project <id> --wait # or run a Marketing Signal audit (separate command tree)
index365 reports context <runId>            # compact, agent-ready report payload
index365 findings list --run <runId>        # triage findings
index365 findings get --run <runId> <findingId>   # full detail + remediation

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/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, pass index365 login --key <key> or set INDEX365_API_KEY to use a key directly with no prompt.

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

Project removal is reversible. projects archive preserves scan history and API keys, and projects restore reactivates the same row. The legacy projects delete command is a compatibility alias for archive and reports Archived, never Deleted. 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

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