Getting started

Set up a bridge and a local agent 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)

npx @buildautomaton/cli

Run from a terminal. You can either:

  • Use npx — no install; first run may download the package
  • Install globally — npm install -g @buildautomaton/cli, then buildautomaton bridge from any directory

Optional: pass a bridge name with -n my_bridge (alphanumeric and underscores only). Your browser opens to sign in and link the workspace; the bridge stays connected until you stop the CLI.

Step 3: Install the agent of your choice

Install the agent of your choice and make it available on PATH; the CLI will use it when requested. Examples: