Getting started

Set up a bridge so your machine can talk to your BuildAutomaton workspace. Follow the steps below.

Step 1: Install Node.js (if needed)

The CLI runs with npx and requires Node.js. If you don’t have it, install the LTS version from nodejs.org .

Step 2: Run the CLI (local bridge)

From a terminal, run the command below. The first run may take a moment while the package is downloaded.

npx @buildautomaton/cli@latest

Your browser opens so you can sign in and link your workspace; the bridge stays connected until you stop the CLI.

Naming your bridge (optional)

You can pass a bridge name with -n or --name when creating a new bridge (e.g. npx @buildautomaton/cli@latest -n my_bridge). The name must be alphanumeric with underscores only (e.g. dev_machine_1). If you omit it, a random name is chosen.

Most of the time, local agents are auto-detected by the CLI bridge—you only need to add or adjust an agent manually if that detection doesn’t run, misses something, or isn’t adequate for your setup. For which agents work with BuildAutomaton, install links, and the broader ACP ecosystem, see Supported agents.