Skip to main content
oi is the agent-first CLI for OpenIndex. It is designed for machine use and scriptability, with all output modes tuned for both human operators and automated pipelines.

​
Command groups

GroupPurpose
queuePull available and active work
work-itemRead, create, update, and transition work
calendarView scheduled work and external calendar events
settingsManage personal, domain, external, and admin configuration
profileConfigure connection profiles
authVerify authentication and token scope

​
Global flags

Every oi command accepts these flags:
FlagShortDescription
--profile <name>Select a named config profile
--json-jForce JSON output
--verbose-vInclude fuller error output

​
JSON mode and auto-detection

When stdout is not a TTY (for example, in pipelines or scripts), oi defaults to JSON output automatically. In TTY mode, output is formatted for human-readable terminal usage. When --json is active, command failures emit a structured error object on stderr: 
{
  "error": {
    "code": "unauthorized",
    "message": "Token is invalid or expired.",
    "hint": "Run oi profile show to inspect the active token.",
    "next_command": "oi profile show"
  }
}
FieldDescription
error.codeMachine-readable error code
error.messageHuman-readable description
error.hintSuggested remediation
error.next_commandSuggested follow-up command

​
Machine-readable schema

Run oi schema at any time to emit the full JSON Schema for all oi commands, arguments, and flags. Use this to drive structured invocations from an agent or build tooling on top of the CLI contract. 
oi schema

​
Help topics

oi includes built-in narrative guides accessible without network access: 
oi help
oi help quickstart
oi help auth
oi help profile
oi help domain
oi help calendar
oi help work-item
oi help workflow
oi help scheduling
oi help updates
oi help troubleshooting
oi help all
For command groups not covered by oi help topics (such as settings), use --help: 
oi settings --help
oi settings personal --help
oi settings domain --help
oi settings external --help
oi settings admin --help

​
Auth diagnostics

oi auth check
oi whoami
Use oi auth check to verify that your token is valid and inspect its effective scope. Use oi whoami to confirm the authenticated identity.

​
Explore the CLI

Installation

Install oi from GitHub releases, Homebrew, or source.

Profiles

Configure profiles for different OpenIndex environments.

Work Items

Create, update, claim, and complete work items.

Queue

Inspect available and active work.

Calendar

View calendar events and manage ICS sources.

Settings

Manage personal, domain, external, and admin settings.