Buildkite Cli

Buildkite CLI

The Buildkite CLI (bk) provides terminal access to builds, jobs, pipelines, secrets, artifacts, clusters, queues, and packages. Use it to trigger builds, tail logs, manage secrets, run a local agent, and automate CI/CD workflows without leaving the command line.

Tip: This skill covers common commands and patterns. For complete flag details on any command, run bk <command> --help. The CLI ships exhaustive examples in its own help output — prefer it as the source of truth for a specific flag.

Quick Start

bk job list --build requires Buildkite CLI v3.53.0 or later. Run bk update if the flag is unavailable.

# Installbrew install buildkite/buildkite/bk
# Authenticate (OAuth — opens a browser)bk auth login
# Trigger a build on the current branch (pipeline auto-detected from the repo)bk build create
# Watch the most recent build runbk build watch
# Inspect build state, find failed jobs, and read a failed job's logbk build view 429 --summarybk job list --pipeline my-app --build 429 --state failedbk job log <job-uuid>

Most build, job, artifact, and pipeline commands resolve the pipeline, branch, and most-recent build from the current git repository. Pass -p/--pipeline explicitly only when outside a repo or when targeting a different pipeline.

Installation

# Homebrew (macOS and Linux)brew install buildkite/buildkite/bk
# Update an existing install (prints the right command for brew/mise installs)bk update

For binary downloads and verification, see references/command-reference.md.

Authentication

bk auth login is the recommended method. It uses OAuth and stores the resulting token in the system keychain — no manual token creation required.

# OAuth login (opens a browser; grants all scopes your account allows)bk auth login
# Login to a specific organizationbk auth login --org my-org
# Login with read-only access (scope group), plus write access to buildsbk auth login --scopes "read_only write_builds"
# Headless / remote machine (no browser)bk auth login --device
# Non-interactive with an existing API token (CI/Docker)bk auth login --org my-org --token "$BUILDKITE_API_TOKEN"

On headless Linux hosts where no keychain is available, pin token storage to an in-memory store: bk config set credential_store shm, then bk auth login --device.

Token-based config (alternative)

bk configure stores a manually-created API token instead of using OAuth. Use it only when OAuth is unavailable.

bk configure --org my-org --token "$BUILDKITE_API_TOKEN"bk configure add --org second-org --token "$OTHER_TOKEN"   # add another org

Create the token at Buildkite > avatar > Personal Settings > API Access Tokens with at least read_builds, write_builds, read_pipelines, and read_artifacts scopes.

Switching organizations

bk use my-other-org      # top-level alias for bk auth switchbk auth switch           # interactive selectionbk organization list     # list configured orgs

CLI configuration

bk config manages persistent settings (default output format, pager, credential store). User config applies globally; --local writes a .bk.yaml in the current directory.

bk config list                          # show effective configbk config set output_format json        # default all output to JSONbk config set selected_org my-org --local

Builds

Create, view, list, cancel, retry, rebuild, watch, and download builds.

Create a build

# Build the current branch and commit (pipeline auto-detected from the repo)bk build create
# Explicit pipeline, branch, and messagebk build create -p my-app -b feature/auth -m "Test auth changes"
# With environment variables and metadatabk build create -e "DEPLOY_ENV=staging" -M "release=true"
# Open the new build in the browserbk build create -w

View a build

bk build view (and most build commands) default to the most recent build on the current branch.

Use --summary for status checks, polling, scripts, and agent workflows. It excludes jobs and expanded pipeline information, and skips artifact and annotation requests.

bk build view --summary             # latest build metadata and statebk build view 429 --summary         # a specific build numberbk build view 429 --summary -o json # compact structured outputbk build view --mine --summary      # latest build by the current user

List builds

bk build list --summary                              # 50 most recent build summariesbk build list --summary --state failed --branch main # filter by state and branchbk build list --summary --since 24h --duration ">20m" # slow builds from the last 24 hoursbk build list --summary --meta-data env=production -o json

Use --summary for metadata-only output; the API requests exclude jobs and expanded pipeline information. Server-side filters (fast): --pipeline, --since, --until, --state, --branch, --creator, --commit, --meta-data. Client-side filters: --duration, --message. Valid states: running, scheduled, passed, failed, blocked, canceled, canceling, skipped, not_run. Pass --state and --branch as comma-separated lists. Use --limit N (default 50) or --no-limit to control paging. See references/command-reference.md for the full filter table.

Watch a build

Stream real-time progress. Blocks until the build completes or is canceled.

bk build watch                       # watch the most recent buildbk build watch 429 -p my-app         # watch a specific buildbk build watch --interval 5          # custom polling interval (seconds)

Cancel, retry, rebuild

bk build cancel 429 -p my-app   # only scheduled/running/failing buildsbk build rebuild 429            # rebuild a specific build (or most recent)

Download build resources

bk build download downloads a build's artifacts to the local filesystem.

bk build download 429 -p my-appbk build download --mine          # most recent build by the current user

Trigger and follow

bk build create -p my-app -b main && bk build watch -p my-app

Jobs

Inspect and act on individual jobs. Jobs are addressed by UUID — bk job log no longer needs pipeline or build context (the -p/-b flags are deprecated and ignored).

View job logs

bk job log 0190046e-e199-453b-a302-a21a4d649d31bk job log <job-uuid> --no-timestamps   # strip timestamp prefixes

List jobs

--step-key and --group-key require Buildkite CLI v3.54.0 or later. Run bk update if either flag is unavailable.

When the build number is known, pass --build so bk job list uses the dedicated cursor-paginated List Jobs endpoint. The pipeline can be explicit or resolved from the current repository or configuration. --state, --step-key, and --group-key are applied server-side; --queue and --duration remain client-side. Use --step-key for every job in a step, including parallel jobs, and --group-key for every job in a group.

bk job list --pipeline my-app --build 429 --state failedbk job list --build 429 --state running # pipeline auto-detectedbk job list --build 429 --step-key testbk job list --build 429 --group-key verification

Without --build, the command searches across recent builds and extracts their embedded jobs:

bk job list --queue test-queue --state runningbk job list --duration ">10m" --order-by duration --no-limit

--step-key and --group-key require --build and can be combined. --limit caps the total jobs emitted, not the API page size. Use --no-limit to follow every cursor page; the CLI preserves all server-side filters across cursor pages. --since and --until cannot be combined with --build.

Retry, cancel, unblock, reprioritize

bk job retry <job-uuid>           # each job UUID can be retried oncebk job cancel <job-uuid>bk job unblock <job-uuid>         # unblock a blocked stepbk job unblock <job-uuid> --data '{"release": "true"}'   # with block-step fieldsbk job reprioritize <job-uuid> 10 # raise scheduling priority

Debugging workflow

bk build list --summary --state failed -p my-appbk job list --pipeline my-app --build 429 --state failedbk job log <job-uuid>

Pipelines

Create, list, view, copy, validate, and convert pipeline configuration.

List and view

bk pipeline list                 # all pipelines (default 100)bk pipeline list --name deploy   # filter by name (partial, case-insensitive)bk pipeline view my-app          # pipeline detailsbk pipeline view my-app -w       # open in browser

Create a pipeline

bk pipeline create "My App" -r "[email protected]:org/my-app.git" --cluster-name "Default"bk pipeline create "My App" -r "[email protected]:org/my-app.git" --dry-run   # synthetic non-mutating preview

Treat pipeline creation and --create-webhook as non-atomic operations: pipeline creation can succeed while SCM webhook creation fails. An SCM webhook delivers repository events and is distinct from an outbound organization notification-service webhook.

For pipeline YAML configuration, step types, and plugins, see the buildkite-pipelines skill.

Copy a pipeline

bk pipeline copy my-app --target "my-app-v2"             # within the orgbk pipeline copy my-app --target "other-org/my-app"      # across orgs (cluster reset)

Validate a pipeline

bk pipeline validate checks YAML against the pipeline schema locally (no API token needed). It does not check repository access, source-control provider setup, permissions, or server-side pipeline creation constraints. Defaults to .buildkite/pipeline.yaml or .yml.

bk pipeline validatebk pipeline validate --file .buildkite/deploy.yml

Convert from another CI system

Convert GitHub Actions, Bitbucket, CircleCI, Jenkins, GitLab (beta), Harness (beta), or Bitrise (beta) config to Buildkite YAML. No login required.

bk pipeline convert -F .github/workflows/ci.yml          # vendor auto-detectedbk pipeline convert -F .gitlab-ci.yml --vendor gitlab    # specify when ambiguouscat .circleci/config.yml | bk pipeline convert --vendor circleci

Output defaults to .buildkite/pipeline.<vendor>.yml (stdout when reading from stdin). Use -o/--output for a custom path.

For converting pipelines from other CI systems in depth, see the buildkite-migration skill.

Secrets

Manage cluster-scoped secrets. All secret commands require --cluster-uuid.

# Create (omit --value to enter it via a masked prompt)bk secret create --cluster-uuid <uuid> --key MY_SECRET --value "$TOKEN"
# List, view, update, deletebk secret list --cluster-uuid <uuid>bk secret get --cluster-uuid <uuid> --secret-id <secret-uuid>bk secret update --cluster-uuid <uuid> --secret-id <secret-uuid> --update-valuebk secret delete --cluster-uuid <uuid> --secret-id <secret-uuid>

Naming rules: keys may contain only letters, numbers, and underscores, and cannot begin with buildkite or bk (case-insensitive). Exception: BUILDKITE_API_TOKEN. Pass --description and an access --policy (YAML) on create or update.

For using secrets inside pipeline YAML (secrets:) and job steps (buildkite-agent secret get), see the buildkite-pipelines and buildkite-agent-runtime skills.

Artifacts

List and download build artifacts. The command is bk artifacts (plural). Build number defaults to the most recent build on the current branch.

bk artifacts list                              # most recent buildbk artifacts list 429 -j <job-uuid>            # a specific job in a buildbk artifacts download --build 429              # all artifacts for a buildbk artifacts download <artifact-id> --build 429

There is no bk artifacts upload. Upload artifacts from within a job step with buildkite-agent artifact upload (see the buildkite-agent-runtime skill). For artifact_paths: in pipeline YAML, see the buildkite-pipelines skill.

Clusters and Queues

The CLI manages clusters, queues, and cluster maintainers directly:

bk cluster listbk cluster create --name "Production"bk queue list <cluster-uuid>bk queue create <cluster-uuid> --key deploybk queue pause <cluster-uuid> <queue-uuid>     # stop dispatching to a queue

Full CRUD exists for bk cluster, bk queue, and bk maintainer. See references/command-reference.md for the command list.

Local Agent

bk agent run downloads the agent, creates a temporary cluster token, and runs an ephemeral buildkite-agent locally — useful for testing pipeline changes against your own machine. Everything is cleaned up on Ctrl+C.

bk agent run                      # latest agent on the Default clusterbk agent run --queue deploy       # listen on a specific queuebk agent install                  # install the binary + a starter config

bk agent list/view/pause/resume/stop manage registered agents in the org.

Preflight, Browse, and Other Commands

bk browse                 # open the current pipeline (filtered to the branch)bk browse 429 -n          # print the build URL instead of opening itbk init                   # scaffold a starter pipeline.yamlbk package push <registry-slug> --file-path pkg.tar.gzbk user invite [email protected] [email protected]bk skill add buildkite-api   # install a Buildkite skill into the current agent

For running a build against local uncommitted changes with bk preflight run, see the buildkite-preflight skill.

Raw API Access

Make direct REST or GraphQL calls with bk api:

bk api '/pipelines/my-app/builds/429?exclude_jobs=true&exclude_pipeline=true'bk api -X POST /pipelines --data '{"name":"New","repository":"git@..."}'bk api --file query.graphql # GraphQL file with a named operation

For comprehensive REST and GraphQL documentation (endpoints, mutations, pagination, webhooks), see the buildkite-api skill.

MCP Server Alternatives

When the Buildkite MCP server is available, prefer MCP tools for read operations — they handle auth, pagination, and parsing. Fall back to the CLI for actions MCP does not cover.

Common Mistakes

Additional Resources

Reference Files

• references/command-reference.md — Installation methods, full bk build list/bk job list filter tables, cluster/queue/maintainer commands, bk agent, bk api, package push, and config details

Further Reading

• Buildkite Docs for LLMs
• Buildkite CLI overview
• CLI command reference
• CLI configuration and authentication
• Managing secrets