https://github.com/buildkite/cli

A command line interface for Buildkite.
https://github.com/buildkite/cli

Last synced: 12 days ago
JSON representation

A command line interface for Buildkite.

• Host: GitHub
• URL: https://github.com/buildkite/cli
• Owner: buildkite
• License: mit
• Created: 2017-08-15T05:33:24.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T22:11:54.000Z (14 days ago)
• Last Synced: 2024-10-24T01:36:24.440Z (14 days ago)
• Language: Go
• Homepage:
• Size: 2.44 MB
• Stars: 167
• Watchers: 22
• Forks: 44
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# bk - The Buildkite CLI

[![Latest Release](https://img.shields.io/github/v/release/buildkite/cli?include_prereleases&sort=semver&display_name=release&logo=buildkite)](https://github.com/buildkite/cli/releases)

A command line interface for [Buildkite](https://buildkite.com/).

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

![bk cli](./images/demo.gif)

## Installing

### Using the binary

`bk` is available as a downloadable binary from the [releases page](https://github.com/buildkite/cli/releases).

### Using Brew

```sh

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](https://github.com/buildkite/cli/issues) and let us know!

## 🔨 Development

Developed using Golang 1.20+ with modules.

```bash

git clone [email protected]:buildkite/cli.git

cd cli/

export BUILDKITE_GRAPHQL_TOKEN=""

go generate

go run cmd/bk/main.go --help

```