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
Global flags
Everyoi command accepts these flags:
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:
Machine-readable schema
Runoi 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.
Help topics
oi includes built-in narrative guides accessible without network access:
oi help topics (such as settings), use --help:
Auth diagnostics
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.