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.

Health Checks

Start local testing by confirming Beacon can find its endpoint configuration, collector, runtime log, and supported harnesses.

Run status

beacon endpoint status gives the broadest local view. It reports the Agent Beacon CLI version, config path, runtime log path, collector health, service state, discovered harnesses, diagnostics, destinations, and last observed event.
beacon endpoint status
For automation or support collection, use JSON output:
beacon endpoint status --json
If you are validating a system-mode install from a managed package, check system paths with elevated privileges:
sudo beacon endpoint status --system

Run doctor

beacon endpoint doctor runs pass/fail health checks and exits non-zero when a hard check fails.
beacon endpoint doctor
Doctor verifies the endpoint configuration file, collector configuration file, runtime JSONL path, runtime log permissions, and the macOS launchd plist. If the runtime log has not been created because no event has been written yet, doctor reports a warning rather than a hard failure.

Discover harnesses

Use discovery to compare configured and detected local runtimes before testing real agent activity.
beacon endpoint discover --json
Confirm that discovered harnesses match the local test scope. Hook-based runtimes such as Cursor, Devin, Factory, Grok Build, and OpenCode may require user or project scoped hook installation before real activity appears.

beacon endpoint status

Inspect endpoint health, diagnostics, destinations, and last-event state.

beacon endpoint doctor

Run local health checks with pass/fail exit behavior.

beacon endpoint discover

Show detected and configured local agent harnesses.

Runtime hooks

Install and inspect hook telemetry for supported harnesses.