README.md

bk - The Buildkite CLI

A command line interface for Buildkite.

Use bk to interact with your Buildkite organization without leaving the terminal 🙌.

Installing

Using the binary

bk is available as a downloadable binary from the releases page.

Using Brew

brew tap buildkite/buildkite && brew install buildkite/buildkite/bk

Usage

Work with Buildkite from the command line.

Usage:
  bk [command]

Examples:
$ bk build view


Available Commands:
  agent       Manage agents
  api         Interact with the Buildkite API
  build       Manage pipeline builds
  cluster     Manage organization clusters
  completion  Generate the autocompletion script for the specified shell
  configure   Configure Buildkite API token
  help        Help about any command
  init        Initialize a pipeline.yaml file
  job         Manage jobs within a build
  package     Manage packages
  pipeline    Manage pipelines
  use         Select an organization
  user        Invite users to the organization

Flags:
  -h, --help   help for bk

Use "bk [command] --help" for more information about a command.

Configure

You'll need to run bk configure first to set up your organization and API token.

💬 Feedback

We'd love to hear any feedback and questions you might have. Please file an issue on GitHub and let us know!

🔨 Development

Developed using Golang 1.20+ with modules.

git clone git@github.com:buildkite/cli.git
cd cli/
export BUILDKITE_GRAPHQL_TOKEN="<token>"
go generate
go run cmd/bk/main.go --help