TheDocumentation Index
Fetch the complete documentation index at: https://docs.pome.sh/llms.txt
Use this file to discover all available pages before exploring further.
pome binary is how you run scenarios against a digital twin, inspect run traces, manage active sessions, and authenticate with the hosted control plane. Every workflow — from local OSS development to CI pipelines targeting the hosted cloud — goes through this single binary.
Installation
Installpome globally with your preferred package manager:
Global flags
These flags apply to everypome command and can be placed anywhere on the command line.
| Flag | Default | Description |
|---|---|---|
--config <path> | .pome.json | Override the config file path. The CLI normally walks up from the current directory to find .pome.json. |
--output <fmt> | terminal | Output format. terminal renders human-readable output; json emits machine-readable JSON. |
--quiet / -q | false | Suppress all non-error output. Useful in scripts where you only care about exit codes. |
--verbose / -v | false | Write debug logs to stderr. Equivalent to setting POME_DEBUG=1. |
--api-url <url> | https://api.pome.sh | Override the cloud API base URL. Use this for self-hosted deployments or staging environments. |
--no-color | false | Disable ANSI color output. |
Commands
| Command | What it does |
|---|---|
pome init | Scaffold a new Pome project with config, harness, and example scenarios |
pome login | Authenticate with the hosted Pome control plane |
pome logout | Remove stored credentials |
pome run | Run one or more scenarios against a twin |
pome inspect | Pretty-print a run’s full trace |
pome export | Export a run as a .tar.gz archive |
pome twin | Boot a standalone twin for manual testing |
pome sessions | List or kill active hosted sessions |
pome version | Print the CLI version |