The agent session token for the job. The variable is read by the agent artifact and meta-data commands.
The value of the debug agent configuration option.
The value of the disconnect-after-idle-timeout agent configuration option.
The value of the disconnect-after-job agent configuration option.
The value of the endpoint agent configuration option. This is set as an environment variable by the bootstrap and then read by most of the buildkite-agent commands.
A list of the experimental agent features that are currently enabled. The value can be set using the --experiment flag on the buildkite-agent start command or in your agent configuration file.
The value of the health-check-addr agent configuration option.
The UUID of the agent.
The value of each agent tag. The tag name is appended to the end of the variable name. They can be set using the --tags flag on the buildkite-agent start command, or in the agent configuration file. The Queue tag is specifically used for isolating jobs and agents, and appears as the BUILDKITE_AGENT_META_DATA_QUEUE environment variable.
The name of the agent that ran the job.
The process ID of the agent.
The artifact paths to upload after the job, if any have been specified. The value can be modified by exporting the environment variable in the environment or pre-checkout hooks.
The path where artifacts will be uploaded. This variable is read by the buildkite-agent artifact upload command, and during the artifact upload phase of command steps. It can only be set by exporting the environment variable in the environment, pre-checkout or pre-command hooks.
The path to the directory containing the buildkite-agent binary.
The branch being built. Note that for manually triggered builds, this branch is not guaranteed to contain the commit specified by BUILDKITE_COMMIT.
The name of the user who authored the commit being built. May be unverified. This value can be blank in some situations, including builds manually triggered using API or Buildkite web interface.
The notification email of the user who authored the commit being built. May be unverified. This value can be blank in some situations, including builds manually triggered using API or Buildkite web interface.
The path where the agent has checked out your code for this build. This variable is read by the bootstrap when the agent is started, and can only be set by exporting the environment variable in the environment or pre-checkout hooks.
The name of the user who created the build. The value differs depending on how the build was created:
The notification email of the user who created the build. The value differs depending on how the build was created:
A colon separated list of non-private team slugs that the build creator belongs to. The value differs depending on how the build was created:
The UUID of the build.
The build number. This number increases with every build, and is guaranteed to be unique within each pipeline.
The value of the build-path agent configuration option.
The url for this build on Buildkite.
The value of the cancel-grace-period agent configuration option in seconds.
The value of the cancel-signal agent configuration option. The value can be modified by exporting the environment variable in the environment or pre-checkout hooks.
Whether the build should perform a clean checkout. The variable is read during the default checkout phase of the bootstrap and can be overridden in environment or pre-checkout hooks.
The UUID value of the cluster, but only if the build has an associated cluster_queue. Otherwise, this environment variable is not set.
The command that will be run for the job.
The opposite of the value of the no-command-eval agent configuration option.
The exit code from the last command run in the command hook.
The git commit object of the build. This is usually a 40-byte hexadecimal SHA-1 hash, but can also be a symbolic name like HEAD.
The path to the agent config file.
The path to the file containing the job's environment variables.
The value of the git-clean-flags agent configuration option. The value can be modified by exporting the environment variable in the environment or pre-checkout hooks.
The value of the git-clone-flags agent configuration option. The value can be modified by exporting the environment variable in the environment or pre-checkout hooks.
The opposite of the value of the no-git-submodules agent configuration option.
The name of the GitHub deployment environment. Only available on builds triggered by a GitHub Deployment.
The GitHub deployment ID. Only available on builds triggered by a GitHub Deployment.
The GitHub deployment payload data as serialized JSON. Only available on builds triggered by a GitHub Deployment.
The name of the GitHub deployment task. Only available on builds triggered by a GitHub Deployment.
The UUID of the group step the job belongs to. This variable is only available if the job belongs to a group step.
The value of the key attribute of the group step the job belongs to. This variable is only available if the job belongs to a group step.
The label/name of the group step the job belongs to. This variable is only available if the job belongs to a group step.
The value of the hooks-path agent configuration option.
A list of environment variables that have been set in your pipeline that are protected and will be overridden, used internally to pass data from the bootstrap to the agent.
The internal UUID Buildkite uses for this job.
The path to a temporary file containing the logs for this job. Requires enabling the enable-job-log-tmpfile agent configuration option.
The label/name of the current job.
The exit code of the last hook that ran, used internally by the hooks.
The opposite of the value of the no-local-hooks agent configuration option.
The message associated with the build, usually the commit message or the message provided when the build is triggered. The value is empty when a message is not set. For example, when a user triggers a build from the Buildkite dashboard without entering a message, the variable returns an empty value.
The UUID of the organization.
The organization name on Buildkite as used in URLs.
The index of each parallel job created from a parallel build step, starting from 0. For a build step with parallelism: 5, the value would be 0, 1, 2, 3, and 4 respectively.
The total number of parallel jobs created from a parallel build step. For a build step with parallelism: 5, the value is 5.
The default branch for this pipeline.
The UUID of the pipeline.
The displayed pipeline name on Buildkite.
The ID of the source code provider for the pipeline's repository.
The pipeline slug on Buildkite as used in URLs.
A colon separated list of the pipeline's non-private team slugs.
A JSON string holding the current plugin's configuration (as opposed to all the plugin configurations in the BUILDKITE_PLUGINS environment variable).
The current plugin's name, with all letters in uppercase and any spaces replaced with underscores.
Whether to validate plugin configuration and requirements. The value can be modified by exporting the environment variable in the environment or pre-checkout hooks, or in a pipeline.yml file. It can also be enabled using the no-plugin-validation agent configuration option.
A JSON object containing a list plugins used in the step, and their configuration.
The opposite of the value of the no-plugins agent configuration option.
The value of the plugins-path agent configuration option.
The number of the pull request or false if not a pull request.
The base branch that the pull request is targeting or "" if not a pull request.`
Set to true when the pull request is a draft. This variable is only available if a build contains a draft pull request.
The repository URL of the pull request or "" if not a pull request.
The UUID of the original build this was rebuilt from or "" if not a rebuild.
The number of the original build this was rebuilt from or "" if not a rebuild.
A custom refspec for the buildkite-agent bootstrap script to use when checking out code. This variable can be modified by exporting the environment variable in the environment or pre-checkout hooks.
The repository of your pipeline. This variable can be set by exporting the environment variable in the environment or pre-checkout hooks.
The path to the shared git mirror. Introduced in v3.47.0.
How many times this job has been retried.
The access key ID for your S3 IAM user, for use with private S3 buckets. The variable is read by the buildkite-agent artifact upload command, and during the artifact upload phase of command steps. The value can only be set by exporting the environment variable in the environment, pre-checkout or pre-command hooks.
The access URL for your private S3 bucket, if you are using a proxy. The variable is read by the buildkite-agent artifact upload command, as well as during the artifact upload phase of command steps. The value can only be set by exporting the environment variable in the environment, pre-checkout or pre-command hooks.
The Access Control List to be set on artifacts being uploaded to your private S3 bucket. The variable is read by the buildkite-agent artifact upload command, as well as during the artifact upload phase of command steps. The value can only be set by exporting the environment variable in the environment, pre-checkout or pre-command hooks.
Must be one of the following values which map to S3 Canned ACL grants.
The region of your private S3 bucket. The variable is read by the buildkite-agent artifact upload command, as well as during the artifact upload phase of command steps. The value can only be set by exporting the environment variable in the environment, pre-checkout or pre-command hooks.
The secret access key for your S3 IAM user, for use with private S3 buckets. The variable is read by the buildkite-agent artifact upload command, as well as during the artifact upload phase of command steps. The value can only be set by exporting the environment variable in the environment, pre-checkout or pre-command hooks. Do not print or export this variable anywhere except your agent hooks.
Whether to enable encryption for the artifacts in your private S3 bucket. The variable is read by the buildkite-agent artifact upload command, as well as during the artifact upload phase of command steps. The value can only be set by exporting the environment variable in the environment, pre-checkout or pre-command hooks.
The value of the shell agent configuration option.
The source of the event that created the build.
The opposite of the value of the no-ssh-keyscan agent configuration option.
A unique string that identifies a step.
The value of the key command step attribute, a unique string set by you to identify a step.
The name of the tag being built, if this build was triggered from a tag.
The number of minutes until Buildkite automatically cancels this job, if a timeout has been specified, otherwise it false if no timeout is set. Jobs that time out with an exit status of 0 are marked as "passed".
Set to "datadog" to send metrics to the Datadog APM using localhost:8126, or DD_AGENT_HOST:DD_AGENT_APM_PORT.
Also available as a buildkite agent configuration option.
The UUID of the build that triggered this build. This will be empty if the build was not triggered from another build.
The number of the build that triggered this build or "" if the build was not triggered from another build.
The slug of the pipeline that was used to trigger this build or "" if the build was not triggered from another build.
The name of the user who unblocked the build.
The notification email of the user who unblocked the build.
The UUID of the user who unblocked the build.
A colon separated list of non-private team slugs that the user who unblocked the build belongs to.
Always true.
Always
true