README
¶
bk - The Buildkite CLI
A command line interface for Buildkite.
Full documentation is available at buildkite.com/docs/platform/cli.
Quick Start
Install
brew tap buildkite/buildkite && brew install buildkite/buildkite/bk
Or download a binary from the releases page.
Authenticate
bk auth login
Feedback
We'd love to hear any feedback and questions you might have. Please file an issue on GitHub and let us know!
Development
This repository uses mise to pin Go and the main local development tools.
git clone git@github.com:buildkite/cli.git
cd cli/
mise install
mise run build
mise run install
mise run install:global
mise run hooks
mise run format
mise run lint
mise run test
mise run generate
go run main.go --help
mise.toml pins the shared toolchain, including the release helpers used in
CI. The module itself remains compatible with Go 1.25.0 as declared in
go.mod.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
auth
Package auth handles commands related to authentication via the CLI
|
Package auth handles commands related to authentication via the CLI |
|
config
Package config provides commands for managing CLI configuration
|
Package config provides commands for managing CLI configuration |
|
generate
command
|
|
|
internal
|
|
|
config
Package config contains the configuration for the bk CLI
|
Package config contains the configuration for the bk CLI |
|
pkg
|
|
|
keyring
Package keyring provides secure credential storage using the OS keychain.
|
Package keyring provides secure credential storage using the OS keychain. |
|
oauth
Package oauth provides OAuth 2.0 PKCE authentication flow for CLI applications
|
Package oauth provides OAuth 2.0 PKCE authentication flow for CLI applications |
Click to show internal directories.
Click to hide internal directories.