CLI reference¶
The stable commands: the ones src/evarness/sdk/stable_tier.yaml lists. They
change only after a deprecation cycle (Stable API). evarness --help
lists every other command; those are internal and may change in any release.
evarness doctor¶
Preflight: can Evarness run on this machine, and what to fix if not.
evarness 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). | |
--model-set |
TEXT | Size the report to this model set (config/doctor.yaml: lite, standard) instead of the one the host fits; --fix applies it. | |
--help |
flag | Show the command's help and exit. |
evarness serve¶
Run the Evarness API in the foreground: the scheduled jobs and the web console.
evarness serve [OPTIONS]
| Option | Type | Default | Description |
|---|---|---|---|
--host |
TEXT | 127.0.0.1 |
Address to bind (env EVARNESS_API_HOST). Anything but loopback is reachable from other machines, and the command warns. |
--port |
INTEGER RANGE | 8003 |
Port to listen on (env EVARNESS_API_PORT). |
--help |
flag | Show the command's help and exit. |
evarness email demo¶
Try Evarness 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 Evarness did, audit rows included. Re-running is safe.
evarness email demo [OPTIONS]
| Option | Type | Default | Description |
|---|---|---|---|
--home |
PATH | The demo's own Evarness home (default: $EVARNESS_DEMO_HOME, else ~/.evarness-demo). Never your real profile. | |
--reset |
flag | Delete the demo home first and start over. | |
--help |
flag | Show the command's help and exit. |
evarness 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.
evarness 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 Evarness 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. |
evarness email writes approve¶
Allow Evarness to change this mailbox: labels, moves to Trash, restores.
evarness 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. |