Developers

CLI

The index365 CLI wraps the REST API for terminals, CI pipelines, and agent shells. The CLI is in private beta: the npm package publishes at general availability, and beta access ships through your account team. Everything below works identically against the live API once you have it.

Authenticate

index365 login            # prompts for your i365_ key, validates, saves with 0600 perms
index365 doctor           # verifies auth, scopes, API reachability, contract version

In CI, skip the config file entirely and set INDEX365_API_KEY. The CLI never prints your secret.

Run an audit end to end

index365 projects list
index365 runs start --project <projectId> --wait     # polls until terminal
index365 reports context <runId> --json              # compact agent context
index365 findings list --run <runId> --severity critical --json
index365 reports download <runId> --output audit.pdf

Marketing Signal audits

index365 marketing run --project <projectId> --wait   # five-stage marketing audit
index365 marketing report --project <projectId>       # latest report (stage scores)
index365 marketing findings --project <projectId> --stage measure --json
index365 integrations list --project <projectId>      # connected-signal providers

CI example

# Fail the pipeline when a deploy degrades AI-readiness
index365 runs start --project "$PROJECT_ID" \
  --idempotency-key "$CI_COMMIT_SHA" --wait --json > run.json
score=$(jq -r .score run.json)
test "$score" -ge 70 || { echo "AI-readiness score $score below 70"; exit 1; }

Conventions

  • --json on every command prints the raw API payload for scripts and agents.
  • Stable exit codes: 0 ok, 1 error, 2 usage, 3 auth, 4 not found, 5 quota/conflict/rate.
  • --idempotency-key makes runs start retry-safe: the same key returns the original run instead of double-spending credits.
  • index365 mcp config prints ready-to-paste MCP host configuration.