Skip to main content

​
Commands

Use this reference to browse Beacon commands by hierarchy. Each command links to the consolidated guide section with examples, flags, and operational notes.

​
beacon

Command syntax
beacon [command]
Top-level Agent Beacon CLI commands.
CommandDescription
beacon versionDisplay the installed Agent Beacon CLI version.
beacon ciRun ephemeral AI runtime telemetry collection in CI.
beacon mcpExpose local Beacon activity to MCP clients.
beacon endpointManage local endpoint telemetry, runtime logs, and integrations.
beacon statusAlias for beacon endpoint status.
beacon doctorAlias for beacon endpoint doctor.
beacon inventoryAlias for beacon endpoint inventory.

​
beacon version

Command syntax
beacon version [command]
Display the installed Beacon version or check for released updates.
CommandDescription
beacon version checkCheck whether a newer Beacon CLI release is available.

​
beacon ci

Command syntax
beacon ci [command]
Run ephemeral Beacon telemetry collection for CI jobs without installing a persistent endpoint service.
CommandDescription
beacon ci execRun a command with Claude Code telemetry captured for CI.
beacon ci validateValidate CI runtime telemetry artifacts.

​
beacon mcp

Command syntax
beacon mcp [command]
Expose local Beacon runtime activity through MCP.
CommandDescription
beacon mcp serveRun the local Beacon MCP server over stdio or loopback HTTP JSON-RPC.
beacon mcp doctorValidate local Beacon MCP setup and print client configuration.

​
beacon endpoint

Command syntax
beacon endpoint [command]
Manage the local endpoint agent and inspect supported agent harness telemetry.
CommandDescription
beacon endpoint installInstall or update the local endpoint collector, runtime telemetry configuration, and optional Splunk HEC or Falcon LogScale HEC forwarding.
beacon endpoint statusInspect collector health, runtime log state, configured harnesses, diagnostics, and forwarding readiness.
beacon endpoint doctorRun local endpoint health checks with pass/fail exit behavior and optional safe remediation.
beacon endpoint inventoryShow configured, detected, hook, and observed endpoint inventory.
beacon endpoint discoverDiscover supported local agent harnesses and their telemetry configuration state.
beacon endpoint test-eventWrite a synthetic endpoint validation event to the runtime JSONL log.
beacon endpoint bundle-diagnosticsWrite a redacted local diagnostics bundle for support and troubleshooting.
beacon endpoint repairRepair Beacon endpoint service files, telemetry configuration, and optional collector forwarding destinations.
beacon endpoint uninstallRemove Beacon endpoint service files, with an option to keep local logs.
beacon endpoint configInspect, validate, and update endpoint configuration.
beacon endpoint dashboardRun the local dashboard over Beacon runtime logs for endpoint inspection.
beacon endpoint wazuhConfigure Wazuh ingestion for Beacon endpoint events.
beacon endpoint elasticGenerate Elastic content and run a local Elasticsearch, Kibana, and Filebeat validation stack.
beacon endpoint datadogGenerate Datadog Agent custom log collection content for Beacon endpoint events.
beacon endpoint sumoGenerate Sumo Logic HTTP Source forwarding content for Beacon endpoint events.
beacon endpoint rapid7Generate Rapid7 InsightIDR Custom Logs forwarding content for Beacon endpoint events.
beacon endpoint sentinelGenerate Microsoft Sentinel Azure Monitor Agent forwarding content for Beacon endpoint events.
beacon endpoint cloudwatchGenerate AWS CloudWatch Logs forwarding content for Beacon endpoint events.
beacon endpoint s3Generate AWS S3 forwarding content for Beacon endpoint events.
beacon endpoint gcsGenerate Google Cloud Storage forwarding content for Beacon endpoint events.
beacon endpoint hooksManage supported hook-based endpoint telemetry.
beacon endpoint integrations openclawSet up and validate OpenClaw Gateway OTLP export.
beacon endpoint integrations claude-coworkSet up and validate Claude Cowork OTLP export.

​
beacon endpoint config

Command syntax
beacon endpoint config [command]
Inspect, validate, and update endpoint configuration.
CommandDescription
beacon endpoint config showPrint endpoint configuration with secrets redacted.
beacon endpoint config validateValidate endpoint configuration and destination settings.

​
beacon endpoint wazuh

Command syntax
beacon endpoint wazuh [command]
Generate Wazuh configuration, content packs, and validation events for Beacon endpoint logs.
CommandDescription
beacon endpoint wazuh print-configPrint a Wazuh localfile snippet for Beacon endpoint events.
beacon endpoint wazuh install-packGenerate Beacon Wazuh rules, sample events, and config snippets into a directory.
beacon endpoint wazuh validateWrite and describe a known-good Beacon Wazuh validation event.

​
beacon endpoint elastic

Command syntax
beacon endpoint elastic [command]
Generate Elastic configuration, content packs, and local validation stacks for Beacon endpoint logs.
CommandDescription
beacon endpoint elastic print-configPrint a Filebeat config for Beacon endpoint events.
beacon endpoint elastic install-packGenerate Elasticsearch, Kibana, Filebeat, and Elastic Agent content into a directory.
beacon endpoint elastic upStart a local Elasticsearch, Kibana, and Filebeat validation stack.
beacon endpoint elastic downStop the local Elastic validation stack.

​
beacon endpoint datadog

Command syntax
beacon endpoint datadog [command]
Generate Datadog Agent custom log collection content and validation events for Beacon endpoint logs.
CommandDescription
beacon endpoint datadog print-configPrint a Datadog Agent custom log config for Beacon endpoint events.
beacon endpoint datadog install-packGenerate Datadog Agent custom log integration content into a directory.
beacon endpoint datadog validateWrite and describe a known-good Beacon Datadog validation event.

​
beacon endpoint sumo

Command syntax
beacon endpoint sumo [command]
Generate Sumo Logic HTTP Source forwarding content and validation events for Beacon endpoint logs.
CommandDescription
beacon endpoint sumo print-configPrint a Sumo HTTP Source smoke-test uploader for Beacon endpoint events.
beacon endpoint sumo install-packGenerate Sumo Logic HTTP Source forwarding content into a directory.
beacon endpoint sumo validateWrite and describe a known-good Beacon Sumo Logic validation event.

​
beacon endpoint rapid7

Command syntax
beacon endpoint rapid7 [command]
Generate Rapid7 InsightIDR Custom Logs forwarding content and validation events for Beacon endpoint logs.
CommandDescription
beacon endpoint rapid7 print-configPrint a Rapid7 Custom Logs webhook smoke-test uploader for Beacon endpoint events.
beacon endpoint rapid7 install-packGenerate Rapid7 InsightIDR Custom Logs forwarding content into a directory.
beacon endpoint rapid7 validateWrite and describe a known-good Beacon Rapid7 validation event.

​
beacon endpoint sentinel

Command syntax
beacon endpoint sentinel [command]
Generate Microsoft Sentinel Azure Monitor Agent forwarding content and validation events for Beacon endpoint logs.
CommandDescription
beacon endpoint sentinel print-configPrint a Sentinel DCR transform for Beacon endpoint events.
beacon endpoint sentinel install-packGenerate Microsoft Sentinel forwarding content into a directory.
beacon endpoint sentinel validateWrite and describe a known-good Beacon Microsoft Sentinel validation event.

​
beacon endpoint cloudwatch

Command syntax
beacon endpoint cloudwatch [command]
Generate AWS CloudWatch Logs forwarding content and validation events for Beacon endpoint events.
CommandDescription
beacon endpoint cloudwatch print-configPrint a Vector AWS CloudWatch Logs forwarding template for Beacon endpoint events.
beacon endpoint cloudwatch install-packGenerate AWS CloudWatch Logs forwarding content into a directory.
beacon endpoint cloudwatch validateWrite and describe a known-good Beacon AWS CloudWatch Logs validation event.

​
beacon endpoint s3

Command syntax
beacon endpoint s3 [command]
Generate AWS S3 forwarding content and validation events for Beacon endpoint logs.
CommandDescription
beacon endpoint s3 print-configPrint a Vector AWS S3 forwarding template for Beacon endpoint events.
beacon endpoint s3 install-packGenerate AWS S3 forwarding content into a directory.
beacon endpoint s3 validateWrite and describe a known-good Beacon AWS S3 validation event.

​
beacon endpoint gcs

Command syntax
beacon endpoint gcs [command]
Generate Google Cloud Storage forwarding content and validation events for Beacon endpoint logs.
CommandDescription
beacon endpoint gcs print-configPrint a Vector Google Cloud Storage forwarding template for Beacon endpoint events.
beacon endpoint gcs install-packGenerate Google Cloud Storage forwarding content into a directory.
beacon endpoint gcs validateWrite and describe a known-good Beacon Google Cloud Storage validation event.

​
beacon endpoint hooks

Command syntax
beacon endpoint hooks [command]
Install, inspect, and remove hook-based telemetry for supported local runtimes.
CommandDescription
beacon endpoint hooks installInstall Beacon endpoint hooks for supported hook harnesses.
beacon endpoint hooks statusShow Beacon endpoint hook integration status for a supported harness.
beacon endpoint hooks uninstallRemove Beacon endpoint hooks for supported harnesses.

​
beacon endpoint integrations claude-cowork

Command syntax
beacon endpoint integrations claude-cowork [command]
Configure and validate Claude Cowork OpenTelemetry export.
CommandDescription
beacon endpoint integrations claude-cowork print-configPrint Claude Cowork OTLP setup guidance for organization administrators.
beacon endpoint integrations claude-cowork setupPrint or create Claude Cowork OTLP admin settings.
beacon endpoint integrations claude-cowork statusShow Claude Cowork endpoint integration status.
beacon endpoint integrations claude-cowork validateValidate whether Claude Cowork events are arriving at the configured collector.

​
beacon endpoint integrations openclaw

Command syntax
beacon endpoint integrations openclaw [command]
Configure and validate OpenClaw Gateway OpenTelemetry export.
CommandDescription
beacon endpoint integrations openclaw print-configPrint OpenClaw Gateway OTLP setup guidance.
beacon endpoint integrations openclaw statusShow OpenClaw Gateway endpoint integration status.
beacon endpoint integrations openclaw validateValidate whether OpenClaw OTLP-derived events are arriving.