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 bundle-diagnostics

beacon endpoint bundle-diagnostics writes a redacted local diagnostics bundle for Beacon endpoint support and troubleshooting.
beacon endpoint bundle-diagnostics --output ./beacon-diagnostics
The bundle is designed for support workflows where an operator needs endpoint configuration, health, inventory, and runtime-log context without exposing secrets by default. Beacon redacts sensitive destination values and only includes runtime event data when explicitly requested.

Bundle Contents

The diagnostics bundle can include:
  • Endpoint status and doctor output
  • Endpoint configuration with secrets redacted
  • Runtime inventory
  • Local path and service metadata
  • Optional redacted event summaries
  • Optional raw runtime JSONL events
If the runtime log does not exist yet, Beacon still writes an empty summary file for requested event summaries so bundle structure remains predictable.
--include-raw-events can include prompt, tool, file, and command telemetry according to the endpoint’s content retention mode. Review the bundle before sharing it outside your organization.

Flags

FlagDescription
--output <dir>Output directory for the diagnostics bundle
--include-event-summariesInclude redacted event summaries
--include-raw-eventsInclude raw runtime JSONL events
--userUse per-user endpoint paths. Enabled by default
--systemUse system endpoint paths and launch daemon
--log-path <path>Runtime JSONL log path

Examples

Write a basic diagnostics bundle:
beacon endpoint bundle-diagnostics --output ./beacon-diagnostics
Include redacted event summaries:
beacon endpoint bundle-diagnostics \
  --output ./beacon-diagnostics \
  --include-event-summaries
Include raw runtime events for local troubleshooting:
beacon endpoint bundle-diagnostics \
  --output ./beacon-diagnostics \
  --include-raw-events
Bundle diagnostics for a system-mode deployment:
sudo beacon endpoint bundle-diagnostics \
  --system \
  --output ./beacon-diagnostics

Endpoint doctor

Run local endpoint health checks with pass/fail exit behavior.

Endpoint config

Inspect and validate endpoint configuration with secrets redacted.