buildkite-agent pause

The Buildkite Agent's pause command is used to manually pause a running Buildkite Agent.

Pausing an agent

Usage

buildkite-agent pause [options...]

Description

Pauses the current agent.

Example

# Pauses the agent
$ buildkite-agent pause

# Pauses the agent with an explanatory note and a custom timeout
$ buildkite-agent pause --note 'too many llamas' --timeout-in-minutes 60

Options

`--note value` #	A descriptive note to record why the agent is paused Environment variable: `$BUILDKITE_AGENT_PAUSE_NOTE`
`--timeout-in-minutes value` #	Timeout after which the agent is automatically resumed, in minutes (default: 0) Environment variable: `$BUILDKITE_AGENT_PAUSE_TIMEOUT_MINUTES`
`--agent-access-token value` #	The access token used to identify the agent Environment variable: `$BUILDKITE_AGENT_ACCESS_TOKEN`
`--endpoint value` #	The Agent API endpoint (default: "`https://agent.buildkite.com/v3`") Environment variable: `$BUILDKITE_AGENT_ENDPOINT`
`--no-http2` #	Disable HTTP2 when communicating with the Agent API. Environment variable: `$BUILDKITE_NO_HTTP2`
`--debug-http` #	Enable HTTP debug mode, which dumps all request and response bodies to the log Environment variable: `$BUILDKITE_AGENT_DEBUG_HTTP`
`--no-color` #	Don't show colors in logging Environment variable: `$BUILDKITE_AGENT_NO_COLOR`
`--debug` #	Enable debug mode. Synonym for `--log-level debug`. Takes precedence over `--log-level` Environment variable: `$BUILDKITE_AGENT_DEBUG`
`--log-level value` #	Set the log level for the agent, making logging more or less verbose. Defaults to notice. Allowed values are: debug, info, error, warn, fatal (default: "notice") Environment variable: `$BUILDKITE_AGENT_LOG_LEVEL`
`--experiment value` #	Enable experimental features within the buildkite-agent Environment variable: `$BUILDKITE_AGENT_EXPERIMENT`
`--profile value` #	Enable a profiling mode, either cpu, memory, mutex or block Environment variable: `$BUILDKITE_AGENT_PROFILE`