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

CLI quickstart

Install Beam, capture a first event, and open your local activity dashboard.

On this page

You need Node.js 20.17 or later, a terminal, and a supported coding assistant if you want live capture. The public package is @agent-beam/beam; the executable is beam. Local scans and Studio do not require a Beam account.

Install Beam

Code
npm install -g @agent-beam/beam
beam --version

For a controlled rollout, pin the version your team has reviewed. The source version used for these guides is 0.2.2. If your shell cannot find beam, check that your npm global binary directory is on PATH before continuing.

Start the local collector

Code
beam start

The collector listens on 127.0.0.1:4319 by default. It prints its local storage path and capture status. Starting also attempts to wire hooks for supported agents detected on the machine, preserving existing hook configuration. Review the output for per-agent errors.

Leave this terminal running. In a second terminal, inspect the supported adapters and open Studio:

Code
beam agent list
beam studio

beam studio opens the local dashboard with a pairing token. Treat the token as a local credential; do not paste the generated URL into a ticket or chat. Studio removes the token from the address bar after reading it.

Capture and inspect an action

Open a supported coding assistant with its Beam hook installed. Ask it to perform a harmless task such as listing project files. In Studio's Activity view, locate the event and inspect the agent, tool, timestamp, and event phase.

A PreToolUse event describes a proposed action. It does not prove that the action ran or succeeded. If nothing arrives, check the assistant's hook configuration, PATH, and whether the collector is still running.

Run your first offline scan

From a project containing a skill file:

Code
beam scan SKILL.md

Read the JSON findings and evidence. The scanner does not execute the file. A successful exit means the scan completed, not that there were no findings. Without --save, the collector is not contacted.

Choose your next step

Use background services if the collector should start at login. Use beam connect for a team workspace, or beam setup for interactive hook installation, browser connection, and optional service setup. Connecting changes where records can be sent; review data and privacy first.

Keep exploring

Explore the docs