CLI reference¶
The stable commands: the ones src/iris_harness/sdk/stable_tier.yaml lists. They
change only after a deprecation cycle (Stable API). iris --help
lists every other command; those are internal and may change in any release.
iris doctor¶
Preflight: can IRIS run on this machine, and what to fix if not.
iris doctor [OPTIONS]
| Option | Type | Default | Description |
|---|---|---|---|
--fix |
flag | Apply the safe fixes: pull models, create a key. | |
--yes, -y |
flag | Apply fixes without asking (implies --fix). | |
--json |
flag | Print the report as JSON (applies no fixes). | |
--help |
flag | Show the command's help and exit. |
iris serve¶
Run the IRIS API in the foreground: the scheduled jobs and the web console.
iris serve [OPTIONS]
| Option | Type | Default | Description |
|---|---|---|---|
--host |
TEXT | 127.0.0.1 |
Address to bind (env IRIS_API_HOST). Anything but loopback is reachable from other machines, and the command warns. |
--port |
INTEGER RANGE | 8003 |
Port to listen on (env IRIS_API_PORT). |
--help |
flag | Show the command's help and exit. |
iris email demo¶
Try IRIS on a synthetic mailbox: fetch, judge, first digest. Offline, no credentials.
Runs in an isolated demo home with a scripted demo model (no model server needed), then prints the digest and what IRIS did, audit rows included. Re-running is safe.
iris email demo [OPTIONS]
| Option | Type | Default | Description |
|---|---|---|---|
--home |
PATH | The demo's own IRIS home (default: $IRIS_DEMO_HOME, else ~/.iris-demo). Never your real profile. | |
--reset |
flag | Delete the demo home first and start over. | |
--help |
flag | Show the command's help and exit. |
iris email setup¶
Set up email, step by step: connect, fetch, discover categories, classify, preview and approve labels, first digest, review queue, keep it current. Resumable.
iris email setup [OPTIONS]
| Option | Type | Default | Description |
|---|---|---|---|
--account |
TEXT | The account to set up (provider:address). | |
--provider |
TEXT | With no --account: 'demo' sets up the synthetic mailbox (inside a demo home only). | |
--yes, -y |
flag | Take every default without asking, except mailbox writes (those need --approve-writes). | |
--approve-writes |
flag | Approve the label preview: let IRIS label mail in this account. | |
--decline-writes |
flag | Decline it: keep the mailbox read-only. | |
--restart |
flag | Forget this account's setup and start over (fetched mail, judgments, categories and approvals stay). | |
--status |
flag | Show where setup stands; change nothing. | |
--help |
flag | Show the command's help and exit. |
iris email writes approve¶
Allow IRIS to change this mailbox: labels, moves to Trash, restores.
iris email writes approve [OPTIONS]
| Option | Type | Default | Description |
|---|---|---|---|
--account |
TEXT | Account id (gmail:you@example.com) or address. | |
--ref |
TEXT | Why, or which approval this is (kept with the row). | |
--yes, -y |
flag | Do not ask (scripts). | |
--help |
flag | Show the command's help and exit. |