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 config

beacon endpoint config inspects and safely updates the local Beacon endpoint configuration. 
beacon endpoint config [command]
Use this command group when you need to review the effective endpoint configuration, validate config file contents, or change content retention without reinstalling the endpoint agent.

​
Commands

show

Print endpoint configuration with secrets redacted.

validate

Validate endpoint configuration and destination settings.

set-retention

Set endpoint content retention mode.

​
Flags

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

​
Content Retention Modes

ModeDescription
metadataRetain metadata fields without prompt or tool-result content where Beacon can separate them
redactedRetain content after Beacon redaction rules are applied
fullRetain full local content in customer-controlled runtime JSONL logs. Default

​
beacon endpoint config show

beacon endpoint config show prints the endpoint configuration with secrets redacted. 
beacon endpoint config show
Splunk HEC tokens and other secret destination values are not printed. Use this command before support handoffs or diagnostics collection when you need to confirm paths, ports, harnesses, retention, and destination settings.

​
Examples

Show per-user endpoint config: 
beacon endpoint config show
Show system endpoint config: 
sudo beacon endpoint config show --system

​
beacon endpoint config validate

beacon endpoint config validate validates the endpoint configuration file. 
beacon endpoint config validate
Validation checks content retention mode and destination configuration. For example, Splunk HEC and Falcon LogScale HEC forwarding require both an endpoint URL and token when configured.

​
Examples

Validate per-user endpoint config: 
beacon endpoint config validate
Validate system endpoint config: 
sudo beacon endpoint config validate --system

​
beacon endpoint config set-retention

beacon endpoint config set-retention updates the endpoint content retention mode. 
beacon endpoint config set-retention <metadata|redacted|full>
Use this command to adjust local retention policy without rewriting the rest of the endpoint configuration. The new mode applies to future events after runtimes emit telemetry through Beacon.

​
Examples

Switch to metadata-only retention: 
beacon endpoint config set-retention metadata
Switch to redacted content retention: 
beacon endpoint config set-retention redacted
Restore full local retention: 
beacon endpoint config set-retention full

Endpoint install

Configure endpoint telemetry, collector service files, and retention settings.

Diagnostics bundle

Collect redacted endpoint support artifacts.