0.0
No release in over a year
CLI for Buildkite, similar to gh for GitHub
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Bk

CLI for poking around Buildkite, like gh for GitHub

Installation

See Development section while in release

Usage

See bk --help and bk <subcommand> --help for most accurate usage. Below are some examples!

Annotations

Usage: bk annotations [slug_or_url]

Display annotations of a specific build:

$ bk annotations https://buildkite.com/your-org/your-pipeline/builds/1234

Display annotations of the most recent build (requires gh):

$ bk annotations

Artifacts

Usage: bk artifacts [slug_or_url] [--glob <pattern>] [--download]

Display artifacts of a specific build:

$ bk annotations https://buildkite.com/your-org/your-pipeline/builds/1234

Display artifacts of a specific build matching a glob (tip: quote the glob pattern to avoid your shell expanding):

$ bk annotations https://buildkite.com/your-org/your-pipeline/builds/1234 --glob "*.log"

Download artifacts of a specific build matching a glob (tip: quote the glob pattern to avoid your shell expanding):

$ bk annotations https://buildkite.com/your-org/your-pipeline/builds/1234 --glob "*.log" --download

Logs

Usage:

  • bk logs <job url>
  • bk logs <your org> <pipeline> <build-number> <job-id>

Displays the logs from a specific job, by URL.

$ bk logs https://buildkite.com/your-org/your-pipeline/builds/1234#1234-5678-90ab-cdef

Displays the logs from a specific job:

$ bk logs your-org your-pipeline 1234 1234-5678-90ab-cdef

To be continue?

More to come? Whatchu want? Feature requests and PRs welcome!

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment. You can run the command from this checkout with:

bk $ bundle exec exe/bk [args...]

To install this gem onto your local machine, run bundle exec rake install. If you want to use bk in different ruby versions, you'll need to use your version manager to switch and install it. You might find this snippet useful:

bk $ rake build
bk 0.1.0 built to pkg/bk-0.1.0.gem.

bk $ cd ~/workspace/some-project
some-project $ gem install ~/workspace/bk/bk-0.1.0.gem

To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/technicalpickles/bk.