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.

beacon endpoint install

beacon endpoint install configures the local endpoint agent, writes the OpenTelemetry Collector configuration, installs the launchd service, and configures selected AI runtime harnesses.
beacon endpoint install --user
By default, Beacon configures Claude Code and Codex CLI telemetry and writes metadata-only events to the runtime JSONL log.

Examples

Install in per-user mode:
beacon endpoint install --user
Install without starting the launchd service:
beacon endpoint install --user --no-start
Configure only one harness:
beacon endpoint install --user --harness claude
Use redacted content retention:
beacon endpoint install --user --content-retention redacted

Flags

FlagDescription
--userUse per-user endpoint paths instead of system paths
--log-path <path>Runtime JSONL log path
--harness <list>Comma-separated harnesses to configure. Defaults to claude,codex
--otlp-grpc-port <port>Local OTLP gRPC port. Defaults to 4317
--otlp-http-port <port>Local OTLP HTTP port. Defaults to 4318
--collector <path>Path to an otelcol or otelcol-contrib binary
--no-startWrite files without starting the launchd service
--content-retention <mode>Content retention mode: metadata, redacted, or full

Paths

ItemUser modeSystem mode
Config~/.beacon/endpoint/config.json/Library/Application Support/Beacon/Endpoint/config.json
Base directory~/.beacon/endpoint/Library/Application Support/Beacon/Endpoint
Runtime log~/.beacon/endpoint/logs/runtime.jsonl/var/log/beacon-agent/runtime.jsonl
Collector config~/.beacon/endpoint/otelcol.yaml/Library/Application Support/Beacon/Endpoint/otelcol.yaml
Production endpoint install is currently supported on macOS. System mode requires root; use --user for non-root local installs.

beacon endpoint status

Check collector, service, harness, and diagnostic status.

beacon endpoint repair

Reapply endpoint service and telemetry configuration.