Skip to main content

​
Command Overview

beacon endpoint bundle-diagnostics writes a redacted local diagnostics bundle for Beacon endpoint support and troubleshooting.
Command syntax
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 from the endpoint runtime log. Review the bundle before sharing it outside your organization.

​
Flags

​
Examples

Write a basic diagnostics bundle:
Write a basic diagnostics bundle
Include redacted event summaries:
Include redacted event summaries
Include raw runtime events for local troubleshooting:
Include raw runtime events for local troubleshooting
Bundle diagnostics for a system-mode deployment:
Bundle diagnostics for a system-mode deployment

Endpoint doctor

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

Endpoint config

Inspect and validate endpoint configuration with secrets redacted.