Scroll to navigation

BUILDBOX-WORKER(1) User Commands BUILDBOX-WORKER(1)

NAME

buildbox-worker - buildbox-worker

SYNOPSIS

buildbox-worker

DESCRIPTION

Display usage and exit.
Print version information and exit. [optional]
Instance name to pass to the Remote Workers API and the CAS servers [optional, default = ""]
Set a custom digest function. Supported functions: SHA512, SHA384, SHA256, SHA1, MD5 [optional, default = "SHA256"]
Number of jobs to run at once, defaults to running one job at a time [optional, default = 1]
Terminate after running the given number of jobs, defaults to non-terminating [optional, default = -1]
Mark worker as UNHEALTHY after N consecutive errors, disabled by default (0 = disabled) [optional, default = 0]
Mark worker as UNHEALTHY if disk usage exceeds threshold. Format: --disk-usage-health-check=/path:80% Can be specified multiple times for different paths. [optional]
URL for all services [optional]
Instance for all services [optional]
Server TLS certificate for all services (PEM-encoded) [optional]
Client private TLS key far all services (PEM-encoded) [optional]
Client TLS certificate for all services (PEM-encoded) [optional]
Authentication token for all services (JWT, OAuth token etc), will be included as an HTTP Authorization bearer token [optional]
Default access token refresh timeout [optional]
Use GoogleAPIAuth for all services [optional]
Credential helper executable for all services [optional]
Retry limit for gRPC errors for all services [optional]
Retry delay for gRPC errors for all services [optional]
gRPC status code(s) as string(s) to retry on for all services, e.g. 'UNKNOWN', 'INTERNAL' [optional]
Timeout for gRPC requests for all services (set to 0 to disable timeout) [optional]
Minimum throughput for gRPC requests for all services, bytes per seconds. The value may be suffixed with K, M, G or T. [optional]
gRPC keepalive pings period for all services (set to 0 to disable keepalive pings) [optional]
gRPC load balancing policy for all services (valid options are 'round_robin' and 'grpclb') [optional]
URL for the Bots service [optional]
Name of the Bots instance [optional]
Server TLS certificate for Bots (PEM-encoded) [optional]
Client private TLS key for Bots (PEM-encoded) [optional]
Client TLS certificate for Bots (PEM-encoded) [optional]
Authentication token for Bots (JWT, OAuth token etc), will be included as an HTTP Authorization bearer token [optional]
Access token refresh timeout for Bots service [optional]
Use GoogleAPIAuth for Bots service [optional]
Credential helper executable for Bots service [optional]
Retry limit for gRPC errors for Bots service [optional]
Retry delay for gRPC errors for Bots service [optional]
gRPC status code(s) as string(s) to retry on for Bots service e.g., 'UNKNOWN', 'INTERNAL' [optional]
Timeout for gRPC requests for Bots service (set to 0 to disable timeout) [optional]
Minimum throughput for gRPC requests for Bots service, bytes per seconds. The value may be suffixed with K, M, G or T. [optional]
gRPC keepalive pings period for Bots service (set to 0 to disable keepalive pings) [optional]
gRPC load balancing policy for Bots service (valid options are 'round_robin' and 'grpclb') [optional]
URL for the CAS service [optional]
Name of the CAS instance [optional]
Server TLS certificate for CAS (PEM-encoded) [optional]
Client private TLS key for CAS (PEM-encoded) [optional]
Client TLS certificate for CAS (PEM-encoded) [optional]
Authentication token for CAS (JWT, OAuth token etc), will be included as an HTTP Authorization bearer token [optional]
Access token refresh timeout for CAS service [optional]
Use GoogleAPIAuth for CAS service [optional]
Credential helper executable for CAS service [optional]
Retry limit for gRPC errors for CAS service [optional]
Retry delay for gRPC errors for CAS service [optional]
gRPC status code(s) as string(s) to retry on for CAS service e.g., 'UNKNOWN', 'INTERNAL' [optional]
Timeout for gRPC requests for CAS service (set to 0 to disable timeout) [optional]
Minimum throughput for gRPC requests for CAS service, bytes per seconds. The value may be suffixed with K, M, G or T. [optional]
gRPC keepalive pings period for CAS service (set to 0 to disable keepalive pings) [optional]
gRPC load balancing policy for CAS service (valid options are 'round_robin' and 'grpclb') [optional]
URL for the LogStream service [optional]
Name of the LogStream instance [optional]
Server TLS certificate for LogStream (PEM-encoded) [optional]
Client private TLS key for LogStream (PEM-encoded) [optional]
Client TLS certificate for LogStream (PEM-encoded) [optional]
Authentication token for LogStream (JWT, OAuth token etc), will be included as an HTTP Authorization bearer token [optional]
Access token refresh timeout for LogStream service [optional]
Use GoogleAPIAuth for LogStream service [optional]
Credential helper executable for LogStream service [optional]
Retry limit for gRPC errors for LogStream service [optional]
Retry delay for gRPC errors for LogStream service [optional]
gRPC status code(s) as string(s) to retry on for LogStream service e.g., 'UNKNOWN', 'INTERNAL' [optional]
Timeout for gRPC requests for LogStream service (set to 0 to disable timeout) [optional]
Minimum throughput for gRPC requests for LogStream service, bytes per seconds. The value may be suffixed with K, M, G or T. [optional]
gRPC keepalive pings period for LogStream service (set to 0 to disable keepalive pings) [optional]
gRPC load balancing policy for LogStream service (valid options are 'round_robin' and 'grpclb') [optional]
URL for the Asset service [optional]
Name of the Asset instance [optional]
Server TLS certificate for Asset (PEM-encoded) [optional]
Client private TLS key for Asset (PEM-encoded) [optional]
Client TLS certificate for Asset (PEM-encoded) [optional]
Authentication token for Asset (JWT, OAuth token etc), will be included as an HTTP Authorization bearer token [optional]
Access token refresh timeout for Asset service [optional]
Use GoogleAPIAuth for Asset service [optional]
Credential helper executable for Asset service [optional]
Retry limit for gRPC errors for Asset service [optional]
Retry delay for gRPC errors for Asset service [optional]
gRPC status code(s) as string(s) to retry on for Asset service e.g., 'UNKNOWN', 'INTERNAL' [optional]
Timeout for gRPC requests for Asset service (set to 0 to disable timeout) [optional]
Minimum throughput for gRPC requests for Asset service, bytes per seconds. The value may be suffixed with K, M, G or T. [optional]
gRPC keepalive pings period for Asset service (set to 0 to disable keepalive pings) [optional]
gRPC load balancing policy for Asset service (valid options are 'round_robin' and 'grpclb') [optional]
Sets the maximum amount of time in seconds between worker polling the Bots service. [optional, default = 60]
Sets the amount of time in seconds to wait for ongoing executions to finish during a graceful shutdown, before escalating to a forceful shutdown. If not provided, ongoing executions will run to completion during graceful shutdown. [optional]
Absolute path to runner executable [required]
Arguments to pass buildbox-run when the worker runs a job This can be useful if the buildbox-run implementation you're using supports non-standard options [optional]
Add a key-value pair to the 'Platform' message the worker sends to the server (see the Remote Workers API specification for keys and values you can use) format is --platform KEY=VALUE [optional]
format is --metrics-mode=MODE where 'MODE' is one of: udp://<hostname>:<port> file:///path/to/file stderr [optional]
Metrics publishing interval [optional]
if set to any value, the format used by statsd publisher, when tagging is set. Supports 'influx', 'graphite' and 'dog', defaults to 'influx' [optional, default = "influx"]
Log verbosity level [optional, default = "info"]
Set log level to debug [optional]
Write logs to this directory with filenames '<program name>.<hostname>.<user name>.log.<severity level>.<date>.<time>.<pid>' [optional, default = ""]
Absolute path to config file [optional, default = ""]
POSITIONAL [optional]
March 2026 buildbox-worker 1.4.0