Skip to main content

​
Developer Setup

Use this path when you want to evaluate Beacon on your own machine before a managed rollout. The default setup uses per-user paths and writes endpoint events to ~/.beacon/endpoint/logs/runtime.jsonl.

​
1. Install Beacon

Install the beacon CLI with Homebrew: 
brew tap asymptote-labs/tap
brew install beacon
beacon version
For other installation options, see Installation.

​
2. Configure local endpoint telemetry

Run the default endpoint install. This configures the local collector and supported runtime telemetry using user-mode paths. 
beacon endpoint install
beacon endpoint status
By default, Beacon configures Claude Code and Codex CLI to export telemetry to the local collector on 127.0.0.1. Gemini CLI telemetry is opt-in; include gemini when you want Beacon to write local Gemini OTLP settings. 
beacon endpoint install --harness claude,codex,gemini
Beacon also discovers supported agent harnesses and validates collection state. 
beacon endpoint discover
See beacon endpoint install, beacon endpoint status, and beacon endpoint discover for command details.

​
3. Review content handling

Beacon can write supported prompt, tool, command, file, approval, and runtime context when the source runtime emits it. Redaction, sanitization, truncation, and event-size limits are applied before events are written to the local runtime log. See Endpoint event schema for event fields and examples.

​
4. Inspect local activity

Open the local dashboard to inspect runtime inventory, summaries, timelines, filters, and event details. 
beacon endpoint dashboard --open
The dashboard reads local Beacon runtime logs. See Dashboard and beacon endpoint dashboard for details.

​
5. Add hooks for richer local telemetry

Antigravity CLI, Claude Code, Cursor, Devin CLI, Devin Desktop, Factory, Grok Build, Hermes Agent, and OpenCode hooks capture supported session, prompt, tool, command, approval, permission, MCP-like, diff, and file edit events where payloads are available. 
beacon endpoint hooks install --harness cursor
beacon endpoint hooks status --harness cursor
For Claude Code hook telemetry: 
beacon endpoint hooks install --harness claude
beacon endpoint hooks status --harness claude
Restart the selected runtime after installing or removing hooks. See Runtime hooks for setup, status checks, and uninstall steps. For Grok Build, project-level hooks write ./.grok/hooks/beacon-endpoint.json and require /hooks-trust in Grok before they execute.

​
6. Clean up when finished

Remove endpoint service files when you are done testing. Use --keep-logs if you want to preserve local runtime logs. 
beacon endpoint uninstall --keep-logs
See beacon endpoint uninstall for details.

Installation

Install Beacon and understand the files it manages.

Endpoint agent

Install, repair, inspect, and uninstall the local endpoint agent.

Runtime hooks

Install, check, and remove supported hook-based endpoint telemetry.

Command reference

Jump to detailed guides for each Beacon command.