Agentbeamdocs

Start here

MDM / Getting startedDevice managementOne place to understand your Apple and Windows fleet, deliver configuration, and request device actions.MDM / Getting startedSet up your workspaceRequest MDM access, check platform readiness, and get your first managed device into inventory.Agent CLI / Getting startedAgent CLI overviewUnderstand agent activity locally, scan the files your assistants use, and connect shared workspace controls when needed.Agent CLI / Getting startedCLI quickstartInstall Beam, capture a first event, and open your local activity dashboard.Agent CLI / Getting startedConnect a workspacePair your machine through the browser or an enrollment code, then verify identity and policy synchronization.
↑ ↓ to navigate · Enter to openEsc to close
Website Open dashboard
Agent CLI/Getting started
Getting started

Connect a workspace

Pair your machine through the browser or an enrollment code, then verify identity and policy synchronization.

On this page

Workspace connection gives the device an identity for sharing activity and receiving policy. It is separate from local Studio pairing and from operating-system MDM enrollment. Choose the intended workspace in the browser before authorizing the device.

Connect through your browser

Code
beam connect

Beam opens a dashboard sign-in flow and waits for authorization. Sign in, select or create the appropriate workspace, and complete the device connection. The CLI prints the connected device ID, organization ID, and API origin. If the device was already enrolled, the new connection replaces its local enrollment.

The connection flow may install an entitled enterprise package. The public CLI's hook capture and the enterprise package's OS-level monitoring have different coverage; inspect the installation output rather than assuming every platform capability is active.

Use an enrollment code

If your administrator provided a code, use:

Code
beam enroll --code YOUR_ENROLLMENT_CODE
beam agent install-all
beam start

Treat enrollment codes as credentials. Do not commit them to scripts or share shell history containing them. The enrollment command also supports --url for an explicitly chosen API base.

Verify your device

Code
beam whoami
beam account
beam sync

whoami displays the local enrollment identity. account asks the workspace API for the signed-in user, workspace, and device status. sync fetches the latest policy into the data directory. Verify that these agree with the dashboard's Agents page.

The running collector synchronizes policy every 60 seconds for an enrolled device. Event forwarding batches up to 15 records, with a partial batch flushed after ten seconds of inactivity. Network failures can leave records only in local storage; forwarding does not guarantee eventual delivery.

Connect a self-hosted dashboard

Set both remote destinations before pairing:

Code
export BEAM_API_URL=https://beam.example.com
export BEAM_DASHBOARD_URL=https://beam.example.com
beam connect

Keep these values in the environment used by the CLI. BEAM_COLLECTOR_URL stays on HTTP loopback; it is not your hosted dashboard URL. Existing devices must re-enroll when moving to an independent installation.

Disconnect

Run beam logout to attempt remote revocation and remove the local identity. If the server cannot be reached, local credentials are still cleared; verify revocation in the dashboard when connectivity returns. Logout is not a full uninstall or a deletion of historical records. A previously cached policy may remain until replaced or expired; use the removal guide when retiring the installation.

Keep exploring

Explore the docs