Aller au contenu

CLI

The maia CLI is the JSON-first public client of @maiaos/sdk. It is the first qualification harness for every later ADE surface. It is not a node, database client, or runtime supervisor.

Not a command grammar

Exact flags, errors, and envelopes belong to installed maia help --json (the whole command tree) plus maia <command> --help --json and the CLI README. Planned families live in the CLI roadmap. Operator and agent workflow notes live in the CLI guide. This page only classifies families by status.

Source-implemented candidate — callable current evidence

These commands are in the current source registry and are source-callable current evidence. They are not implemented under the release-gated AGENTS meaning and are not product enablement:

  • maia help / maia --help
  • maia status (shortcut for maia node status)
  • maia version / maia --version
  • maia doctor — read-only check of the installation, the Node and accounts
  • maia completion <bash|zsh|fish>
  • maia project register | list | show
  • maia workspace list | show
  • maia workspace repository attach
  • maia receipt show
  • maia receipt list — bounded no-payload index; grammar in maia help receipt --json
  • maia integration status codex|claude-code
  • maia reference resolve — the exact ID of a name, ID prefix or the current folder
  • maia session create | list | show | events list

maia status is read/probe-only in desktop-managed mode. integration status reads an integration's approval and starts no model turn.

Source-implemented candidate — blocked

These exist in source and remain blocked. They are not enabled:

  • maia session start — blocked Codex activation
  • session turn send / session turn show — ordinary routing rejects the family
  • macOS live-terminal create/list/show/events/read, controller request/show/acquire/release, input write, resize/signal/close
  • local-v1 maia run orchestration subset

Unavailable or inert terminal surfaces include observer attach/check/detach/resync, controller renew, restart, delete, and reconcile.

maia context show is a source-implemented, release-disabled Client-principal candidate. It is not enabled product behavior.

Planned

Not present as enabled product behavior:

  • Git-worktree create/remove
  • Structured session attachments, approvals, steering, interruption
  • Agent Sessions, Skills, Routines, Swarm, adapters, and live observability
  • Skill bundle recommendation, install, or sync
  • ADR-015 maia api list | show | invoke and Session-bound maia notebook lifecycle, variable, checkpoint, handoff, and execute families; TypeScript execution additionally requires A6/W3 hard containment
  • Desktop/mobile ADE parity
  • Remote access and deployment flows
  • Inbox --scope current

Next action

Use maia help --json for the command tree, then maia <command> --help --json for one command's arguments. Then read the CLI README, the CLI guide, and the CLI roadmap. Foundation notes live on Node, Protocol, and SDK. Product names live on Product Surfaces. The complete accepted Notebook contract lives in the execution specification.

Imported from Maia OS docs at 3dc3e07