Obi CLI commands

Commands accept --json, and the commands that call your account accept --timeout-ms <100-30000> (see global options). Commands that start paid work or approve your review take an explicit confirmation flag, such as --confirm-scan or --confirm-review, so they never run by accident. obi --help prints the full grammar of your installed version.

Account and setup

status

obi status

Reads your connected account and the next step it is waiting for. AUTH_REQUIRED means this machine is not signed in.

obi login --expect-email <email> [--storage file]

Connects this machine to your account through the browser; see the quickstart. --expect-email is required when the command does not run in an interactive terminal. --storage file keeps the connection in an owner-only file instead of the system credential store, and is required on Windows.

logout

obi logout

Signs this machine out.

credentials

obi credentials list
obi credentials revoke <credentialId> [--force]

list shows the live CLI connections of your account that you may see, most recently used first, with each device label, CLI version and dates. revoke ends one connection. Revoking the connection this machine uses is refused unless you add --force, which also signs this machine out.

skill

obi skill install
obi skill path

install links the bundled Skill into ~/.agents/skills/obi and ~/.claude/skills/obi, and never replaces an existing entry. path prints where the bundled Skill is.

doctor

obi doctor

A local diagnostic that sends no request: your Node.js version, the CLI version, the server origin it is pinned to, where the connection is stored, and whether the video tools yt-dlp and ffmpeg are installed.

capabilities

obi capabilities --json

The commands, actions and options this installed version supports, and the version of the expertise its Skill carries.

How Obi’s work reaches your account

Obi researches your business, writes your buyer questions and reasons over your results in your assistant. The Skill reads the work your account expects with harness show and saves your assistant’s result with harness submit, stage by stage: business, then questions, then strategies. See Harness work. Because your assistant does this work, the server-side commands business start, business discover, questions prepare and questions edit are refused with HARNESS_REQUIRED or HARNESS_QUESTIONS_REQUIRED.

Business

These commands display and correct the business review. All of them except show act on the review version you last displayed: pass the --snapshot <token> that business show returned, and read business show again after each change.

obi business show
obi business clarify-identity --snapshot <token> --company <name>
obi business clarify-fact <itemId> --snapshot <token> --field-path <path> --text <answer> --company <current name> --company-wide [--segment-name <name>]
obi business challenge <itemId> --snapshot <token> --reason <reason>
obi business correct <itemId> --snapshot <token> --claim-id <id> --field-path <path> --text <correction> --company <current name> --company-wide
obi business add-competitor <domain> --snapshot <token> [--reason <reason>]
obi business remove-competitor <domain> --snapshot <token> [--reason <reason>]
obi business readd-competitor <domain> --snapshot <token> [--reason <reason>]
obi business remove <competitorItemId> --snapshot <token> [--reason <reason>]
obi business confirm --snapshot <token> --confirm-review

Action	What it does
`show`	Displays the current review: identity, summary, target buyer, competitors, with sources
`clarify-identity`	Sets the company name
`clarify-fact`	Answers a missing fact for the whole company; `--segment-name` names a buyer segment you add
`challenge`	Disputes a sourced claim, with a reason
`correct`	Replaces a sourced claim with your correction
`add-competitor`, `remove-competitor`, `readd-competitor`, `remove`	Change the competitor set
`confirm`	Confirms the review once; it does not start a scan

See Business review.

Questions and scans

obi questions show
obi questions proceed --candidate-version <n> --confirm-scan
obi questions results [--run latest|first|<run ID>] [--from <question position>]

Action	What it does
`show`	The current question set, its version and its preparation state
`proceed`	Starts the scan of the displayed question version
`results`	The measured answers, with engines, dates and citations

proceed needs both the version you reviewed and --confirm-scan. After a timeout, run questions show before anything else. results reads the latest completed scan and lists your scans, newest first. --run first or --run <run ID> reads another one; a long scan comes in pages, and --from reads the same scan from a later question. See Buyer questions and Scans and engines.

Readiness and strategies

obi readiness
obi strategies

readiness reads the saved Readiness report; it never starts a new reading. strategies reads your saved priorities.

Memory

obi memory list
obi memory add --kind <preference|constraint|decision> --text "<your words>"
obi memory remove <id>

What Obi remembers about how you work, across assistants and sessions: a preference (“answer in French”), a constraint (“never propose rival X”) or a decision (“French market first”). Business facts are not memory: they live in the sourced review and its corrections.

Harness work

The Skill runs these for you; you rarely need them yourself.

obi harness coverage
obi harness activate --free
obi harness show --stage <business|questions|strategies> [--packs <1-40>]
obi harness submit --stage <business|questions|strategies> --input <file>
obi harness evidence --work-id <UUID> [--kind claims|sections|measurements] [--cursor <cursor>] [--query <text>] [--url <exact URL>] [--all --output <file>]
obi harness artifact <save|show|history|export> --work-id <UUID> [--input <JSON file>] [--revision <n>] [--output <new file>] [--cursor <cursor>] [--limit <1-100>]
obi harness outcomes --task-id <UUID> [--cursor <event-id>] [--limit <1-50>]
obi harness observe --input <file>
obi harness purchase <quote|prepare|status|resume|change> [--input <file>] [--confirm-checkout] [--confirm-change]

Action	What it does
`coverage`	Your plan’s question and engine coverage, and whether the Free plan can be activated
`activate --free`	Activates the Free plan on an eligible account; starts no scan
`show`	The work context of a stage: work ID, version, allowed sources, next batch
`submit`	Saves your assistant’s result for a stage
`evidence`	Searches the saved facts, page sections or scan measurements of a work; `--all` exports them to a file
`artifact`	Saves, shows, lists the revisions of, or exports a draft
`outcomes`	Reads the outcomes recorded for a saved task
`observe`	Records an implementation you confirmed
`purchase`	Quotes a first plan for reviewed questions, prepares its checkout, reads its status, resumes it, or changes an existing paid plan

purchase prepare requires --confirm-checkout and returns a checkout page on agent.hireobi.com, which it opens in your browser when it can. purchase resume takes the quote ID only and never starts a second checkout. purchase change changes the packs or engines of an existing paid plan. Without --confirm-change it only previews the change and charges nothing: the amount due now for an increase, or the date a reduction takes effect. The same command with --confirm-change applies that previewed change. See Plans.

Local research helpers

These run on your machine and write local files; they send nothing to your account and take no --timeout-ms.

obi research crawl <domain> --checkpoint <file> --output <file> [--batch-size <1-100>] [--locale <tag>] [--pages priority|all] [--max-pages <n|none>] [--retry-failed|--refresh]
obi research capture --input <selected-page-file> --checkpoint <file> --output <corpus-file>
obi research readiness --input <corpus-file> --output <report-file>
obi research video <url> --output <directory> [--frames <0-30>]

Action	What it does
`crawl`	Reads a site’s pages in resumable batches, keeping its progress in the checkpoint file
`capture`	Adds a page your assistant’s browser observed to the corpus
`readiness`	Writes a Readiness report from a corpus
`video`	Saves a video’s metadata and one caption track, plus up to 30 still frames, to the directory; needs `yt-dlp`, and `ffmpeg` for frames

Reading through your machine shows what that machine sees; it does not prove what an AI provider’s crawler can reach.

Operator evaluations

obi eval start <domain>
obi eval list

Authorized Obi operators can evaluate a public company in an isolated case, then add --eval-case <id> to status, business, harness, readiness, questions, strategies and memory. An evaluation does not prove ownership of that company’s website.

Get started

How Obi works

CLI reference

Account

For AI agents

Obi CLI commands

Account and setup

status

logout

credentials

skill

doctor

capabilities

How Obi’s work reaches your account

Business

Questions and scans

Readiness and strategies

Memory

Harness work

Local research helpers

Operator evaluations

​Account and setup

​status

​login

​logout

​credentials

​skill

​doctor

​capabilities

​How Obi’s work reaches your account

​Business

​Questions and scans

​Readiness and strategies

​Memory

​Harness work

​Local research helpers

​Operator evaluations

Account and setup

status

login

logout

credentials

skill

doctor

capabilities

How Obi’s work reaches your account

Business

Questions and scans

Readiness and strategies

Memory

Harness work

Local research helpers

Operator evaluations