Skip to main content

​
Command Overview

beacon endpoint status reports the current local endpoint configuration, collector status, launchd service state, discovered harnesses, diagnostics, destination status, and the last observed Beacon event.
Command syntax
beacon endpoint status

​
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 status as JSON

​
Examples

Show endpoint status with the default per-user paths:
Show endpoint status with the default per-user paths
beacon endpoint status
Print machine-readable status:
Print machine-readable status
beacon endpoint status --json
Check a custom runtime log path:
Check a custom runtime log path
beacon endpoint status --log-path /path/to/runtime.jsonl
Check system-mode status for a root-managed deployment:
Check system-mode status for a root-managed deployment
sudo beacon endpoint status --system

​
Output

Status includes:
  • Agent Beacon CLI version
  • Config path and runtime log path
  • Runtime-log source warnings if a system collector may be writing OTLP events to a different log
  • Collector health and configured OTLP ports
  • launchd service status
  • Discovered agent harnesses, including Beacon-managed or customer-managed telemetry state for Gemini CLI, VS Code Copilot, GitHub Copilot CLI, and Factory Droid when present
  • Endpoint diagnostics
  • Destination configuration in JSON output, including Splunk HEC or Falcon LogScale HEC endpoint, index, source, and sourcetype when configured
  • Last Beacon event in the runtime log, when present
When Splunk HEC is configured, --json includes a destinations.splunk_hec object with configured: true and the non-secret destination settings. When Falcon LogScale HEC is configured, --json includes destinations.falcon_hec with the same non-secret fields. HEC tokens are not printed. File-based destinations such as Wazuh, Elastic, Datadog, Sumo Logic, Rapid7, Microsoft Sentinel, and AWS S3 validate against the configured runtime log path and their generated shipper configuration.

Endpoint install

Configure the local collector and supported runtime telemetry.

Endpoint doctor

Run local health checks with pass/fail exit behavior.

Endpoint inventory

Show configured, detected, and observed endpoint inventory.

Endpoint dashboard

Inspect Beacon runtime logs in a local dashboard.