docs

opentraces

Open schema + CLI for capturing coding-agent traces, reviewing them locally, and publishing structured datasets to Hugging Face Hub.

opentraces is built around a simple rule: capture locally, review locally, push explicitly. The tool parses agent sessions into a stable schema, runs layered security scanning and redaction, enriches each trace with git and attribution signals, and uploads sharded JSONL to a dataset you control.

Workflow

opentraces setup            # wire opentraces into your system
opentraces init             # initialize the project marker
opentraces web              # or: opentraces tui   — review the inbox
opentraces blame <sha>      # or: opentraces graph  — inspect attribution
opentraces add <id>         # stage a trace for the next push
opentraces push             # upload staged traces
opentraces reject <id>      # say no, keep local only
opentraces redact <id>      # find-and-replace before re-pushing
opentraces push             # upload
opentraces pull             # import traces from a remote dataset

init writes the committable project marker at .opentraces.json. Captured traces, runtime state, and upload bookkeeping stay machine-local under ~/.opentraces/projects/<slug>/.

What You Get

For individual developers. A local inbox for reviewing traces before upload, plus a standard dataset format you can publish privately or publicly.

For teams. Shared remotes on Hugging Face, explicit review policy per repo, and deterministic upload shards that never append in place.

For dataset consumers. A schema designed for training, evaluation, analytics, and attribution rather than a raw dump of vendor-specific logs.

Schema Design

The schema is a standalone package and the contract between capture, review, export, and downstream consumers.

  • Training: normalized steps, tool calls, observations, reasoning, outcomes
  • Analytics: token counts, cost estimates, timing, cache behavior
  • Attribution: git links and file or line provenance when available
  • Interop: export paths for ATIF and Agent Trace style consumers

Start Here

SectionWhat's inside
InstallationInstall, verify, upgrade, uninstall
AuthenticationOAuth, PATs, HF_TOKEN, auth precedence
Quick StartInitialize a repo, review traces, upload your first shard
CommandsCurrent 0.3 command reference
Inbox & ReviewWeb viewer, TUI, and CLI review loop
PushUpload behavior, remotes, visibility, migration, quality badges
Security TiersRegex, entropy, TruffleHog, Tier 2 review, human approval
Security ConfigurationGlobal config, project marker, exclusions, custom redaction
SchemaTrace structure and field semantics
ConsumeLoading datasets back out of Hugging Face