Buildkite Plugins

Add plugins to command steps in your YAML pipeline to add functionality to Buildkite. Plugins can do things like execute steps in Docker containers, read values from a credential store, or add test summary annotations to builds.

Screenshot of a pipeline step with a plugin, and the plugin from the directory

What is a plugin?

A plugin is a Git repository that overrides or extends a command step’s behaviour using one or more hooks. To use a plugin, you reference it in your pipeline YAML configuration, and when that step is run your agent will clone and execute each of the plugin’s hooks.

Plugins can be open source and available for anyone to use, or private repositories available only to your organization and agents. Plugins can be hosted and referenced via a number of sources.

Some plugins allow configuration. This is usually defined in your pipeline.yml file, and is read by the agent before the plugin hooks are run. See each plugin's readme for detailed configuration and usage instructions.

Finding plugins

In the Buildkite Plugin Directory you can find all the plugins maintained by Buildkite, as well as plugins from third party developers.

Creating a plugin

See the Writing Plugins documentation for step-by-step instructions on how to create a plugin. Plugins can be open source, and published to the Plugin Directory, or kept in private repositories that only your agents can access.