- Auto-Instrumentation (Recommended) - Automatically captures traces and checkpoints
- Manual API - Explicit control over checkpoints and tracing
Installation
Auto-Instrumentation (Recommended)
The simplest way to use Omium. One-time setup, then your existing code works unchanged.Initialize
Instrument LangGraph
Instrument CrewAI
Manual Tracing
For explicit control over what gets traced.@trace Decorator
@checkpoint Decorator
Callback Handler
For LangChain-style callback integration:OmiumClient API
For direct checkpoint management:OmiumClient Methods
| Method | Description |
|---|---|
connect() | Establish connection to Omium services |
close() | Close connection |
create_checkpoint() | Create a new checkpoint |
get_checkpoint() | Retrieve a checkpoint by ID |
list_checkpoints() | List checkpoints for an execution |
set_execution_context() | Set default execution/agent context |
Configuration
OmiumConfig
Config File
The CLI stores config in~/.omium/config.json: