The cross-harness, self-improving memory layer for AI agents. Join our community: https://discord.com/invite/zdNChS2fBu
Go agent-ai-cliagent-harnessesagent-securitybrowser-extensionciclaude-codecloudcodexcursordetection-engineeringjevknowledge-basememorymobile-device-managementobservabilitysecuritysecurity-information-and-event-managementsecurity-toolstelemetrytraces
---
title: "beacon endpoint"
description: "Install, inspect, repair, and remove the Beacon endpoint agent"
---
## Command overview
The `beacon endpoint` command group manages the local Beacon [endpoint agent](/concepts/core-concepts#endpoint-agent). It configures agent harness telemetry, runs a [local OpenTelemetry Collector](/concepts/core-concepts#local-collector), writes Beacon [endpoint events](/concepts/core-concepts#endpoint-event) to JSONL, and exposes subcommands for local inspection and integrations. Endpoint commands use per-user paths by default; pass `--system` for root-managed package or MDM deployments.
```bash title="Command syntax"
beacon endpoint [command]
```
## Commands
<span id="beacon-endpoint-install" />
<span id="beacon-endpoint-status" />
<span id="beacon-endpoint-doctor" />
<span id="beacon-endpoint-inventory" />
<span id="beacon-endpoint-discover" />
<span id="beacon-endpoint-test-event" />
<span id="beacon-endpoint-bundle-diagnostics" />
<span id="beacon-endpoint-repair" />
<span id="beacon-endpoint-uninstall" />
<span id="beacon-endpoint-config" />
<span id="beacon-endpoint-onboarding" />
<span id="beacon-endpoint-fx" />
<span id="beacon-endpoint-cursor" />
<span id="beacon-endpoint-harness2" />
<span id="beacon-endpoint-connect" />
<span id="beacon-endpoint-disconnect" />
<span id="beacon-endpoint-asymptote" />
<span id="beacon-endpoint-traces" />
<Columns cols={2}>
<Card title="beacon endpoint install" icon="download" href="/cli/endpoint-install">
Configure endpoint telemetry, collector service files, and harness telemetry.
</Card>
<Card title="beacon endpoint status" icon="circle-info" href="/cli/endpoint-status">
Show collector, service, harness, diagnostic, and runtime log status.
</Card>
<Card title="beacon endpoint connect" icon="link" href="/cli/endpoint-connect">
Enroll this device with the signed-in CLI account and start the Vector forwarder. System mode uses browser approval.
</Card>
<Card title="beacon endpoint disconnect" icon="link-slash" href="/cli/endpoint-connect">
Stop the Beacon forwarder and remove the local device key.
</Card>
<Card title="beacon endpoint doctor" icon="stethoscope" href="/cli/endpoint-doctor">
Run local endpoint health checks with pass/fail exit behavior.
</Card>
<Card title="beacon endpoint repair" icon="wrench" href="/cli/endpoint-repair">
Reapply service files and telemetry configuration.
</Card>
<Card title="beacon endpoint uninstall" icon="trash" href="/cli/endpoint-uninstall">
Stop services and remove managed endpoint files.
</Card>
<Card title="beacon endpoint config" icon="gear" href="/cli/endpoint-config">
Inspect endpoint configuration and validate destination settings.
</Card>
<Card title="beacon endpoint onboarding" icon="envelope" href="/cli/endpoint-onboarding">
Show, reset, or resend the one-time onboarding record.
</Card>
<Card title="beacon endpoint fx" icon="rotate" href="/cli/endpoint-fx">
Collect telemetry from fx session records on this machine.
</Card>
<Card title="beacon endpoint harness2" icon="rotate" href="/cli/endpoint-harness2">
Collect telemetry from Harness² rollouts recorded under its runs directory.
</Card>
<Card title="beacon endpoint cursor" icon="rotate" href="/cli/endpoint-cursor">
Collect Cursor session records and Admin API token usage.
</Card>
<Card title="beacon endpoint copilot" icon="rotate" href="/cli/endpoint-copilot">
Collect telemetry from GitHub Copilot CLI session records.
</Card>
<Card title="beacon endpoint dsh" icon="rotate" href="/cli/endpoint-dsh">
Collect telemetry from DeepSeek Harness session records.
</Card>
<Card title="beacon endpoint traces" icon="magnifying-glass" href="/cli/endpoint-traces">
Index, list, search, and show local traces from runtime logs.
</Card>
<Card title="beacon endpoint asymptote" icon="tower-broadcast" href="/cli/asymptote">
Generate the Beacon forwarding pack for running Vector by hand.
</Card>
<Card title="beacon scan" icon="magnifying-glass" href="/cli/scan">
Run threat-detection rules over local endpoint telemetry.
</Card>
<Card title="beacon rules" icon="shield-halved" href="/cli/rules">
Manage local threat-detection rules used by scans.
</Card>
</Columns>
Additional endpoint commands: [`inventory`](/cli/endpoint-inventory), [`discover`](/cli/endpoint-discover), [`test-event`](/cli/endpoint-test-event), and [`bundle-diagnostics`](/cli/endpoint-bundle-diagnostics).
## Common paths
| Item | User mode | System mode |
|------|-----------|-------------|
| Config | `~/.beacon/endpoint/config.json` | `/Library/Application Support/Beacon/Endpoint/config.json` |
| Base directory | `~/.beacon/endpoint` | `/Library/Application Support/Beacon/Endpoint` |
| Runtime log | `~/.beacon/endpoint/logs/runtime.jsonl` | `/var/log/beacon-agent/runtime.jsonl` |
| Collector config | `~/.beacon/endpoint/otelcol.yaml` | `/Library/Application Support/Beacon/Endpoint/otelcol.yaml` |
## Related groups
<Columns cols={2}>
<Card title="Core Concepts" icon="book-open" href="/concepts/core-concepts">
Review endpoint agent, collector, harness, and runtime log terminology.
</Card>
<Card title="Dashboard" icon="chart-line" href="/cli/dashboard">
Inspect Beacon runtime logs in a local dashboard.
</Card>
<Card title="Wazuh" icon="shield" href="/cli/wazuh">
Manage Wazuh localfile, rule, and validation content.
</Card>
<Card title="Datadog" icon="chart-line" href="/cli/datadog">
Manage Datadog Agent custom log collection content.
</Card>
<Card title="Runtime hooks" icon="plug" href="/cli/hooks">
Manage supported hook-based endpoint integrations.
</Card>
<Card title="OpenClaw Gateway" icon="network-wired" href="/cli/openclaw">
Manage OpenClaw Gateway OpenTelemetry export.
</Card>
</Columns>
Other related guides: [Claude Cowork](/cli/claude-cowork), [Rapid7 InsightIDR](/cli/rapid7), [AWS S3](/cli/s3), and [Google Cloud Storage](/cli/gcs).