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 doctor

beacon endpoint doctor runs local health checks for the Beacon endpoint agent and exits non-zero when any check fails. 
beacon endpoint doctor
Use doctor when rollout automation, support scripts, or an operator needs a pass/fail health signal. For a broader status view that includes collector readiness, service state, discovered harnesses, and last-event state, use beacon endpoint status. beacon doctor is a top-level alias for beacon endpoint doctor.

​
Checks

Doctor verifies:
  • Endpoint configuration file
  • Collector configuration file
  • Runtime JSONL log path
  • Runtime log permissions
  • launchd plist on macOS
The runtime log itself can be missing before the first event is written. In that case, doctor reports a warning instead of a hard failure.

​
Flags

FlagDescription
--userUse per-user endpoint paths. Enabled by default
--systemUse system endpoint paths and launch daemon
--log-path <path>Runtime JSONL log path
--jsonPrint doctor results as JSON

​
Examples

Run health checks with the default per-user paths: 
beacon endpoint doctor
Check a root-managed endpoint deployment: 
sudo beacon endpoint doctor --system
Print machine-readable check results: 
beacon endpoint doctor --json
Use the top-level alias: 
beacon doctor

Endpoint status

Inspect collector, service, harness, diagnostics, and runtime-log state.

Endpoint inventory

Show configured, detected, and observed endpoint inventory.