Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.asymptotelabs.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
For Individual Developers

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. Beacon also discovers supported runtimes and validates collection state. 
beacon endpoint discover
See beacon endpoint install, beacon endpoint status, and beacon endpoint discover for command details.

​
3. Choose content retention

Beacon records configured content fields by default in local or customer-controlled logs. For a metadata-only local evaluation, reinstall with: 
beacon endpoint install --content-retention metadata
Retention modes:
ModeBehavior
fullIncludes configured content fields, subject to event size limits
redactedIncludes configured content fields after local redaction and size limits
metadataExcludes prompt text, raw attributes, command output, and raw diffs
See Endpoint event schema for content-retention fields and example events.

​
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

Cursor and Factory hooks capture supported session, prompt, tool, command, approval, MCP-like, and file edit events where payloads are available. 
beacon endpoint hooks install --harness cursor
beacon endpoint hooks status --harness cursor
Restart Cursor after installing or removing hooks. See Runtime hooks for setup, status checks, and uninstall steps.

​
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 Cursor and Factory hook-based endpoint telemetry.

Command reference

Jump to detailed guides for each Beacon command.