omium CLI is the fastest way to authenticate, run scripts with tracing, inspect failures, and push projects to Automations.
Install
The CLI is installed with the Python package:Quick reference
| Goal | Command |
|---|---|
| Authenticate | omium init |
| Run a script | omium run your_script.py |
| List executions | omium list |
| Show one execution | omium show <execution_id> |
| Stream logs | omium logs <execution_id> |
| Replay | omium replay <execution_id> [--checkpoint-id <id>] |
| Create project scaffolding | omium project init --name my-agent |
| Push project to Automations | omium project push |
Authentication
omium init
Interactive setup (recommended):
Running code
omium run
--project <name>: group runs under a project name--env KEY=VALUE: pass environment variables (repeatable)--no-trace: disable automatic tracing for a run--execution-id <id>: supply your own ID (useful for correlating with your systems)
Inspecting executions
omium list
omium show
omium logs
Recovery
omium replay
Replay an execution from the latest checkpoint (or a specific checkpoint):
Projects and Automations
Projects appear in Automations after you push them.omium project init
omium project push
omium project push.
Environment variables
| Variable | Meaning |
|---|---|
OMIUM_API_KEY | API key (overrides config file) |
OMIUM_API_URL | API host URL (e.g. https://api.omium.ai) |
OMIUM_DEBUG | Enable debug logging |
Next steps
Configure
Where keys and config live, and how env overrides work.
API keys & billing
Review spend and manage keys in the dashboard.