A command line interface for Buildkite.
Use bk to interact with your Buildkite organization without leaving the terminal 🙌.
Note
The 3.x (default) branch is under current active development. If you'd like to use the most recent released version of the Buildkite CLI, please refer to the main branch and releases page for details and installation instructions.
bk is available as a downloadable binary from the releases page.
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
Flags:
-h, --help help for bk
Use "bk [command] --help" for more information about a command.
You'll need to run bk configure first to set up your organization and API token.
We'd love to hear any feedback and questions you might have. Please file an issue on GitHub and let us know!
Developed using Golang 1.20+ with modules.
git clone [email protected]:buildkite/cli.git
cd cli/
export BUILDKITE_GRAPHQL_TOKEN="<token>"
go generate
go run cmd/bk/main.go --help