Skip to content

Setup Guides

Practical setup guides for Agent Tracer. If you want to understand how the runtime and API contracts instead of how to install it, use the reference pages below.

Quick start

Agent Tracer currently has two guided setup paths:

  • Claude Code plugin setup
  • Codex bootstrap via repo-local hooks plus repo-local config

Minimal setup path

  1. Install and Run — clone the repo, install dependencies, start the monitor server and web dashboard, verify the installation.
  2. Claude Code Setup — load the plugin and register the MCP server. Claude Code integration is complete after these two steps.
  3. Codex Setup — use plain codex with the generated repo-local hooks and config.

Attach to external projects (optional)

If you want to use Agent Tracer with a project outside this repository, follow an additional step:

  1. External Project Setup — run npm run setup:external to generate .claude/settings.json, .codex/config.toml, and .codex/hooks.json in your target project.

Note: When running Claude Code inside the Agent Tracer repository itself, setup:external is not needed. You can start with claude --plugin-dir packages/runtime directly.

Other runtimes (manual HTTP/MCP)

Runtimes other than Claude Code and Codex do not have automatic adapters. See External Project Setup § 6 for the minimal implementation order to call the HTTP API directly.

Reference

Once you're set up, these pages describe the event surface and runtime model in more detail.

Local-first documentation for Agent Tracer.