Skip to main content

Reverie command-line interface

Project description

reverie-cli

The reverie command-line interface.

Commands

reverie run <cmd...>          Run any command with Reverie auto-instrumentation.
reverie status                Ping the configured backend and show its health.
reverie runs list             List recent runs.
reverie runs show <run-id>    Show one run plus its event timeline.
reverie replay <run-id>       Stream a run's events to the terminal (Phase 1 preview).

How reverie run works

reverie run python my_agent.py does three things:

  1. Prepends a small bootstrap directory to PYTHONPATH. The directory contains a sitecustomize.py that Python imports automatically before any user code.
  2. The bootstrap calls reverie_openai.auto(), which registers a tracing processor with the OpenAI Agents SDK. Your agent code is unchanged.
  3. Spawns your command as a subprocess and waits for it to exit, then exits with the same status code.

This works for any Python entrypoint — python script.py, python -m module, python -c "..." — and is the same mechanism opentelemetry-instrument uses.

Limitations of the bootstrap

If your project ships its own sitecustomize.py, our hook tries to import yours afterward but cannot guarantee perfect compatibility. Set REVERIE_NO_SITECUSTOMIZE_CHAIN=1 to disable chaining if it causes issues.

For non-Python commands (reverie run node app.js), the CLI still runs the command but no instrumentation is injected.

Configuration

Var Default Description
REVERIE_BACKEND_URL http://127.0.0.1:8000 Backend base URL
REVERIE_NO_SITECUSTOMIZE_CHAIN unset Skip chaining to user's sitecustomize

Install

uv pip install -e ".[dev]"
reverie status

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reverie_cli-0.1.0-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file reverie_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: reverie_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for reverie_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6b0a3273c3a40fba1539e178f6e2a8bb8d7b59e3fc057b4ec8d01e0ac4a565aa
MD5 134c7a6ecb1210a1e2f2c4f02c3bde2c
BLAKE2b-256 15871f2ca33cc62abf1cecf2db35cd038c5cbef35595695eb4c2b8cb8dc1a94d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page