sincecutoff.com
← all changes

bk agent install installs an agent binary and configures a cluster token

Introduced 2026-03-31 · score 0.96

HOW TO USE IT

When installing a Buildkite agent, run `bk agent install` to download the binary and create a token plus minimal config for the Default cluster. Use `--cluster-uuid` to select a cluster, `--no-token` to skip token and config creation, and `--dest` to choose the binary directory.

bk agent install
bk agent install --cluster-uuid <cluster-uuid>
bk agent install --dest <directory> --no-token

WHY THIS HELPS

Install a Buildkite agent binary and configure it to join a cluster.

REQUIREMENTS AND LIMITATIONS

  • Version: v3.33.0
  • --version <version>: Agent version to install; defaults to `latest`.
  • --dest <directory>: Destination directory for the binary; the command chooses a default if omitted.
  • --cluster-uuid <uuid>: Cluster UUID to create the agent token on; defaults to the `Default` cluster.
  • --no-token: Skip creating an agent token and config file.
  • --config-path <path>: Path to write the agent config file; defaults to the platform-specific config path.
  • Prerequisite: Token/config creation initializes the API client and creates a token for the selected cluster; the install source does not document required auth scopes or setup.
  • The command is phase 1 of a two-phase onboarding process.
  • Installing to `/usr/local/bin` requires `sudo`; the default destination is under `$HOME`.
  • `--no-token` may be needed for OAuth scopes or when only the binary is wanted.

FIRST-PARTY EVIDENCE

Check the installed version and the source before using it. Entry JSON

Report a problem with this card