Documentation Index
Fetch the complete documentation index at: https://docs.pome.sh/llms.txt
Use this file to discover all available pages before exploring further.
| Command | What it does |
|---|
pome init | Scaffold scenarios/, examples/agents/, pome.config.json. |
pome login | Sign in via the browser; write a pme_… key to ~/.pome/credentials.json. |
pome run <path> | Run a scenario file (or every .md in a directory) against the bundled twin. Add --hosted for a cloud twin. |
pome inspect latest | Print a human-readable report of the most recent run. |
pome twin start <name> | Start a standalone twin on a local port. Prints the base URL and bearer token. |
pome twin reset | Reset standalone twin state. |
pome twin status | Show the running standalone twin. |
pome endpoints <name> | List supported endpoints for a twin. |
pome health | In-process smoke check against the bundled GitHub twin. |
pome version | Print the CLI version. |
Common flags on pome run
--agent <command> — the command pome should spawn as the agent.--hosted — run against a cloud twin instead of in-process.--artifacts-dir <dir> — where to write runs/. Defaults to ./runs.--agent-model <name> — informational, recorded on hosted runs.
Env vars pome injects into your agent
| Variable | When |
|---|
POME_TASK | Always. The scenario prompt. |
POME_GITHUB_REST_URL, POME_GITHUB_MCP_URL, POME_GITHUB_TOKEN | GitHub twin. |
POME_STRIPE_API_BASE, POME_STRIPE_API_KEY | Stripe twin. |
POME_RUN_ID, POME_ARTIFACTS_DIR | Always. Use these to write per-run artifacts. |
POME_PREFLIGHT=1 | Set during a dry-run pass. Your agent should no-op. |
Exit codes
| Code | Meaning |
|---|
| 0 | All scenarios passed. |
| 1 | At least one scenario scored below threshold. |
| 2 | Twin or runner error (network, 5xx, twin spawn failed). |
| 3 | Auth error (401/403). Re-run pome login. |
| 4 | Quota exceeded. |
| 5 | Usage error (bad flags, missing files). |
Auth resolution order
POME_API_KEY env var.~/.pome/credentials.json written by pome login.
If neither is set, --hosted fails fast.