Setup Guides
Practical setup guides for Agent Tracer. If you want to understand how the code is organised instead of how to install it, go to the codebase wiki.
Quick start (Claude Code plugin)
Agent Tracer is distributed as a Claude Code plugin (.claude/plugin/). The plugin automatically registers all hook events and posts them to the monitor server. You do not need to copy hook source files or perform manual configuration.
Minimal setup path
- Install and Run — clone the repo, install dependencies, start the monitor server and web dashboard, verify the installation.
- Claude Code Setup — load the plugin and register the MCP server. Claude Code integration is complete after these two steps.
Attach to external projects (optional)
If you want to use Agent Tracer with a project outside this repository, follow an additional step:
- External Project Setup — run
npm run setup:externalto generate.claude/settings.jsonin your target project and confirm the--plugin-dirpath.
Note: When running Claude Code inside the Agent Tracer repository itself,
setup:externalis not needed. You can start withclaude --plugin-dir .claude/plugindirectly.
Other runtimes (manual HTTP/MCP)
Runtimes other than Claude Code do not have automatic adapters. See External Project Setup § 5 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.
- Runtime capabilities — how the capability registry tracks per-runtime differences
- API integration map — every HTTP endpoint mapped to hooks and manual-runtime use
- Runtime API flow & preprocessing — preprocessing applied inside each endpoint
- Claude Code hook payload spec — exact JSON shape of each hook payload consumed by the plugin
- Task observability —
FlowandHealthread model used by the dashboard - Web styling guide — CSS / Tailwind conventions used by
@monitor/web
Related
- Codebase wiki — architecture, packages, and maintainer notes
- Claude Code plugin adapter — internal view of the plugin you installed
setup:externalautomation script — what the setup script actually does