Skip to main content

​
Command overview

beacon endpoint onboarding inspects the one-time onboarding record written the first time beacon endpoint install runs in a terminal.
Command syntax
The record lives in ~/.beacon/profile.json. It survives uninstall, so reinstalling Beacon never asks the email and usage questions again. The destination question is asked again on the next interactive install until a destination is recorded; an Beacon answer is recorded only once the connect succeeds.

​
First-run onboarding

The first interactive beacon endpoint install asks two questions, how you are using Beacon and your email, then sends the answers to Beacon once. This is how we decide which agent runtimes and integrations to build next. It then asks a third question, where this machine’s telemetry should go: keep it on the machine, forward it to your own infrastructure (a SIEM, observability platform, or an S3/GCS bucket you own, with a pointer to the log forwarding docs), or forward it to Beacon Managed, which runs beacon endpoint connect after the install. That answer stays local and is never sent. What is sent, and nothing else: Prompts, file contents, commands, telemetry events, and repository names are never sent. The endpoint agent itself stays local-only; this is one request at install time, not an ongoing channel. The prompt never appears non-interactively. Package postinstall scripts, MDM deployments, --system installs, CI, --dry-run, and any piped or redirected stdin skip it silently. The destination question is also skipped on an endpoint already connected to Beacon. A machine onboarded before the question existed is asked it once, on its next interactive install.

​
Flags

​
Unattended installs

Set BEACON_ONBOARDING=0 to suppress the prompt on an install that would otherwise be interactive. There is no CLI flag for this: it exists for unattended CI and MDM workflows. BEACON_MANAGED_INGEST=0 hides only the Beacon Managed answer from the destination question; beacon endpoint install --connect still connects when asked explicitly.
Suppress the prompt
For a fleet rollout where you do want attribution but have no terminal, supply both answers up front and Beacon records them without prompting:
Headless attribution for MDM
BEACON_ONBOARDING_USAGE accepts work, personal, or evaluating. An invalid value is reported on stderr and ignored rather than failing the install.

​
Examples

Show what was recorded, including the answer to the destination question (Telemetry destination: local only …, own infrastructure … or Beacon Managed; absent when it has not been asked, or when a Beacon answer has not yet been carried through to a connected machine):
Show the onboarding record
The answer is stored as onboarding.destination in ~/.beacon/profile.json and takes one of three values; --json exposes it as destination: Clear it so the next install asks again:
Reset the onboarding record
Retry a submission that could not reach Beacon. A failed submission never fails an install; the payload is kept and retried automatically on the next install or repair.
Resend a queued signup
To have your record deleted, email the install ID shown by this command to support@asymptotelabs.ai.

Endpoint install

Configure endpoint telemetry and collector service files.

Endpoint config

Inspect, validate, and update endpoint configuration.