Note: This is the 3.0 development branch of the buildkite-agent, and may not contain files or code in the current stable release. To see code or submit PRs for stable agent versions, please use the corresponding maintenance branch: 2.6.x.
The buildkite-agent is a small, reliable, and cross-platform build runner that makes it easy to run automated builds on your own infrastructure. It’s main responsibilities are polling buildkite.com for work, running build jobs, reporting back the status code and output log of the job, and uploading the job's artifacts.
Full documentation is available at buildkite.com/docs/agent
$ buildkite-agent --help Usage: buildkite-agent <command> [arguments...] Available commands are: start Starts a Buildkite agent artifact Upload/download artifacts from Buildkite jobs meta-data Get/set data from Buildkite jobs pipeline Make changes to the pipeline of the currently running build bootstrap Run a Buildkite job locally help, h Shows a list of commands or help for one command Use "buildkite-agent <command> --help" for more information about a command.
The agents page on Buildkite has personalised instructions for installing the agent with Ubuntu (via apt), Debian (via apt), macOS (via homebrew), Windows and Linux. You can also run the agent via Docker.
To start an agent all you need is your agent token, which you can find on your Agents page within Buildkite.
$ buildkite-agent start --token
$ docker-compose run agent bash [email protected]:/go/src/github.com/buildkite/agent# go run *.go start --token xxx --debug
# Make sure you have go installed. brew install go # Setup your GOPATH export GOPATH="$HOME/Code/go" export PATH="$HOME/Code/go/bin:$PATH" # Checkout the code go get github.com/buildkite/agent cd "$GOPATH/src/github.com/buildkite/agent"
To test the commands locally:
go run main.go start --debug --token "abc123"
We're using govendor to manage our Go depenencies. Install it with:
go get github.com/kardianos/govendor
If you introduce a new package, just add the import to your source file and run:
govendor fetch +missing
Or explicitly fetch it with a version using:
govendor fetch github.com/buildkite/[email protected]
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request
Copyright (c) 2014-2016 Keith Pitt, Buildkite Pty Ltd. See LICENSE for details.