Command reference

The full command tree, generated from the CLI source (run omi --help for the live version):

omi
|-- version
|-- ask
|-- chat
|-- auth           login | logout | status | whoami | refresh
|-- config         show | path | set | profile {list, use, delete}
|-- memory         list | get | create | update | delete
|-- conversation   list | get | create | from-segments | update | delete
|-- action-item    list | get | create | update | complete | delete
|-- goal           list | get | create | update | progress | history | delete
|-- local          configure | status | tools | call | search-screen | screenshot | recap | sql | task {search, complete, delete}
`-- app            events | payload | send | verify | serve

Command inventory

Command	Help
`omi version`	Print the omi-cli version.
`omi ask`	Ask a natural-language question, answered from your own Omi conversations.
`omi chat`	Chat with Omi in your terminal, with streaming replies and shared history.

omi auth — Manage authentication: login, logout, status.

Command	Help
`omi auth login`	Authenticate this profile. Prompts for browser or API key if no flag is given.
`omi auth logout`	Clear credentials for the active profile.
`omi auth status`	Show the auth state of the active profile.
`omi auth whoami`	Resolve the current credential against the API and display identity info.
`omi auth refresh`	Force-refresh the OAuth ID token (no-op for API-key profiles).

omi config — View and modify CLI configuration / profiles.

Command	Help
`omi config show`	Print the resolved configuration (credentials masked).
`omi config path`	Print the on-disk config path.
`omi config set`	Set a per-profile config value. Keys: api_base, local_api_url, local_token.
`omi config profile list`	List all configured profiles.
`omi config profile use`	Switch the active profile.
`omi config profile delete`	Delete a profile and its credentials.

omi memory — Memories — facts and learnings about the user.

Command	Help
`omi memory list`	List memories.
`omi memory get`	Fetch a single memory by ID.
`omi memory create`	Create a new memory.
`omi memory update`	Update an existing memory.
`omi memory delete`	Delete a memory by ID.

omi conversation — Conversations — captured & processed audio + text.

Command	Help
`omi conversation list`	List conversations.
`omi conversation get`	Fetch a single conversation by ID.
`omi conversation create`	Create a conversation from raw text.
`omi conversation from-segments`	Create a conversation from structured transcript segments (JSON file).
`omi conversation update`	Update conversation title or discard status.
`omi conversation delete`	Delete a conversation by ID.

omi action-item — Action items — tasks and follow-ups.

Command	Help
`omi action-item list`	List action items.
`omi action-item get`	Fetch a single action item by ID. (Not directly exposed by the dev API; uses list scan.)
`omi action-item create`	Create a new action item.
`omi action-item update`	Update an existing action item.
`omi action-item complete`	Mark an action item as completed (shortcut for `update --completed`).
`omi action-item delete`	Delete an action item by ID.

omi goal — Goals — tracked progress metrics.

Command	Help
`omi goal list`	List goals.
`omi goal get`	Fetch a single goal by ID.
`omi goal create`	Create a new goal. Up to 3 active goals per user. Omit all metric options for a qualitative goal.
`omi goal update`	Update a goal’s metadata.
`omi goal progress`	Update only the current_value of a goal (shortcut).
`omi goal history`	Fetch progress history for a goal.
`omi goal delete`	Delete a goal by ID.

omi local — Local Omi Desktop API tools.

Command	Help
`omi local configure`	Store local Omi Desktop API settings on the active profile.
`omi local status`	Show local API configuration and probe Omi Desktop when configured.
`omi local tools`	List local Omi Desktop tools available to the CLI.
`omi local call`	Call a local Omi Desktop tool by name.
`omi local search-screen`	Semantic search over local Rewind screen history.
`omi local screenshot`	Fetch a screenshot by ID.
`omi local recap`	Get a pre-formatted daily local activity recap.
`omi local sql`	Run SQL against the local Omi Desktop database.
`omi local task search`	Semantic search over local Omi tasks.
`omi local task complete`	Mark a task complete.
`omi local task delete`	Delete a task permanently.

omi app — Build and test Omi apps: webhook events, samples, local receiver.

Command	Help
`omi app events`	List the webhook events an Omi app can receive.
`omi app payload`	Print the sample body for one event.
`omi app send`	Send one sample event to a webhook URL.
`omi app verify`	Check whether a webhook URL would work in production.
`omi app serve`	Receive webhook deliveries locally and print them.

Global flags

--json                 Emit JSON to stdout (machine-readable, agent-friendly).
--profile, -p NAME     Use a specific profile from ~/.omi/config.toml.
--api-base URL         Override the API base URL.
--verbose, -v          Log HTTP traffic to stderr.
--no-color             Disable colored output (also honors $NO_COLOR).
--timeout SECONDS      Per-request timeout for Developer API calls.
--version              Print the version.
--help                 Show contextual help.

Global flags must come before the subcommand (omi --json memory list, not omi memory list --json). This is a Click framework constraint; you’ll get a friendly usage message if you put them in the wrong place.

`omi auth`

Command	Notes
`omi auth login`	Interactive prompt: pick browser OAuth or paste an API key.
`omi auth login --browser`	Force the Firebase OAuth browser flow (default provider: Google).
`omi auth login --browser --provider apple`	Same flow, Apple Sign-In.
`omi auth login --api-key K`	Force the API-key path. Exposes the key in `ps` and shell history. Prefer the prompt.
`omi auth logout`	Clear the active profile’s credentials.
`omi auth status`	Show profile + masked credential + API base. OAuth profiles also show expiry.
`omi auth whoami`	Round-trip to the API to verify the credential is valid.
`omi auth refresh`	Force-refresh the OAuth ID token. No-op for API-key profiles.

OAuth ID tokens are auto-refreshed before each request when the cached token is past (or near) its expiry. You should rarely need to call refresh by hand. The refresh token rotates if Firebase decides to.

`omi config`

Command	Notes
`omi config show`	Print all profiles + masked credentials.
`omi config path`	Print the on-disk config file path.
`omi config set api_base URL`	Override the API base for the active profile.
`omi config profile list`	Tabular list of profiles.
`omi config profile use NAME`	Switch the active profile. Creates it if missing.
`omi config profile delete NAME`	Wipe a profile (prompts unless `--yes`).

`omi memory`

Command	Endpoint
`omi memory list [--limit N --offset N --categories CSV]`	`GET /v1/dev/user/memories`
`omi memory get ID`	client-side scan (no direct GET in the dev API)
`omi memory create CONTENT [--category C --visibility V --tag T...]`	`POST /v1/dev/user/memories`
`omi memory update ID [--content ... --category ... --visibility ... --tag ...]`	`PATCH /v1/dev/user/memories/{id}`
`omi memory delete ID [-y]`	`DELETE /v1/dev/user/memories/{id}`

Categories: core, hobbies, lifestyle, interests, habits, work, skills, learnings, other, system. Visibility: public or private.

`omi conversation`

Command	Endpoint
`omi conversation list [...filters]`	`GET /v1/dev/user/conversations`
`omi conversation get ID [--include-transcript]`	`GET /v1/dev/user/conversations/{id}`
`omi conversation create --text ... [...]`	`POST /v1/dev/user/conversations`
`omi conversation from-segments FILE.json [--source ...]`	`POST /v1/dev/user/conversations/from-segments`
`omi conversation update ID [--title ... --discarded/--no-discarded]`	`PATCH /v1/dev/user/conversations/{id}`
`omi conversation delete ID [-y]`	`DELETE /v1/dev/user/conversations/{id}`

The --text flag accepts - to read from stdin:

cat meeting_notes.md | omi conversation create --text - --text-source message

`omi action-item`

Command	Endpoint
`omi action-item list [--completed/--open ...]`	`GET /v1/dev/user/action-items`
`omi action-item get ID`	client-side scan
`omi action-item create DESC [--due-at ISO]`	`POST /v1/dev/user/action-items`
`omi action-item update ID [--description ... --completed/--open --due-at ... --clear-due-at]`	`PATCH /v1/dev/user/action-items/{id}`
`omi action-item complete ID`	shortcut for `update --completed`
`omi action-item delete ID [-y]`	`DELETE /v1/dev/user/action-items/{id}`

`omi goal`

Command	Endpoint
`omi goal list [--limit N --include-inactive]`	`GET /v1/dev/user/goals`
`omi goal get ID`	`GET /v1/dev/user/goals/{id}`
`omi goal create TITLE --target N [--type ...] [...]`	`POST /v1/dev/user/goals`
`omi goal update ID [...]`	`PATCH /v1/dev/user/goals/{id}`
`omi goal progress ID VALUE`	`PATCH /v1/dev/user/goals/{id}/progress`
`omi goal history ID [--days N]`	`GET /v1/dev/user/goals/{id}/history`
`omi goal delete ID [-y]`	`DELETE /v1/dev/user/goals/{id}`

Use omi goal update ID --unit liters to set a unit label or omi goal update ID --clear-unit to remove it. These options are mutually exclusive. Omitting both leaves the unit unchanged. Goal types: boolean, scale, numeric. Up to 3 active goals per user; the oldest is deactivated automatically when you create a fourth.

`omi app`

Build and test an Omi app without a device. Every event is a POST to the URL the user configures in Developer Settings; these commands replay the same request locally and receive it locally.

Command	What it does
`omi app events`	List the webhook events an app can receive, with their body shapes.
`omi app payload EVENT [--uid UID]`	Print the sample body for one event.
`omi app send EVENT --to URL [--uid U] [--payload-file F] [--idempotency-key K] [--timeout S]`	POST one sample event the way Omi posts it.
`omi app verify --to URL [--event E] [--uid U]`	Report whether a URL would work in production.
`omi app serve [--port N] [--host H] [--status N] [--reply JSON] [--requests N]`	Receive deliveries locally and print each one.

Events: memory_created, realtime_transcript, day_summary, audio_bytes, button_event.

omi app serve --reply '{"message": "Noted, I will remind you"}'   # one terminal
omi app send realtime_transcript --to http://127.0.0.1:8787/webhook  # another

send exits non-zero when the receiver does not answer 2xx, so it works as a check in CI. It also reports what Omi would do next: whether the delivery would be retried or dropped, and for realtime_transcript whether your reply was long enough to reach the user as a notification. verify posts every event to one URL and prints a report card: whether Omi’s delivery client would accept the URL at all, the status and latency per event, whether a failure would be retried or dropped, and whether a realtime_transcript reply would reach the user. A private or loopback host, a redirect, or a response slower than 30 seconds all fail, because the backend refuses the first, never follows the second, and gives up on the third. It exits non-zero when any check fails. The events it posts are real deliveries, so point it at staging if your app writes somewhere on receipt.

Environment variables

Variable	Effect
`OMI_API_KEY`	Use this dev API key without persisting anything to disk. Validated against the prefix.
`OMI_API_BASE`	Override the API base URL (handy for staging or local backends).
`OMI_PROFILE`	Default profile name when `--profile` is not passed.
`OMI_LOCAL_API_URL`	Base URL for `omi local` Desktop API commands.
`OMI_LOCAL_TOKEN`	Token for `omi local` Desktop API commands.
`OMI_CONFIG`	Path to the config file (default `~/.omi/config.toml`).
`NO_COLOR`	Disable color output (standard, see no-color.org).

API reference

Platform reference

Legal

Command inventory

Global flags

`omi auth`

`omi config`

`omi memory`

`omi conversation`

`omi action-item`

`omi goal`

`omi app`

Environment variables