Scroll to navigation

TREXE(1) User Commands TREXE(1)

NAME

trexe - trexe

SYNOPSIS

trexe

DESCRIPTION

Display usage and exit.
Print version information and exit. [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 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 ActionCache service [optional]
Name of the ActionCache instance [optional]
Server TLS certificate for ActionCache (PEM-encoded) [optional]
Client private TLS key for ActionCache (PEM-encoded) [optional]
Client TLS certificate for ActionCache (PEM-encoded) [optional]
Authentication token for ActionCache (JWT, OAuth token etc), will be included as an HTTP Authorization bearer token [optional]
Access token refresh timeout for ActionCache service [optional]
Use GoogleAPIAuth for ActionCache service [optional]
Credential helper executable for ActionCache service [optional]
Retry limit for gRPC errors for ActionCache service [optional]
Retry delay for gRPC errors for ActionCache service [optional]
gRPC status code(s) as string(s) to retry on for ActionCache service e.g., 'UNKNOWN', 'INTERNAL' [optional]
Timeout for gRPC requests for ActionCache service (set to 0 to disable timeout) [optional]
Minimum throughput for gRPC requests for ActionCache service, bytes per seconds. The value may be suffixed with K, M, G or T. [optional]
gRPC keepalive pings period for ActionCache service (set to 0 to disable keepalive pings) [optional]
gRPC load balancing policy for ActionCache service (valid options are 'round_robin' and 'grpclb') [optional]
URL for the Execution service [optional]
Name of the Execution instance [optional]
Server TLS certificate for Execution (PEM-encoded) [optional]
Client private TLS key for Execution (PEM-encoded) [optional]
Client TLS certificate for Execution (PEM-encoded) [optional]
Authentication token for Execution (JWT, OAuth token etc), will be included as an HTTP Authorization bearer token [optional]
Access token refresh timeout for Execution service [optional]
Use GoogleAPIAuth for Execution service [optional]
Credential helper executable for Execution service [optional]
Retry limit for gRPC errors for Execution service [optional]
Retry delay for gRPC errors for Execution service [optional]
gRPC status code(s) as string(s) to retry on for Execution service e.g., 'UNKNOWN', 'INTERNAL' [optional]
Timeout for gRPC requests for Execution service (set to 0 to disable timeout) [optional]
Minimum throughput for gRPC requests for Execution service, bytes per seconds. The value may be suffixed with K, M, G or T. [optional]
gRPC keepalive pings period for Execution service (set to 0 to disable keepalive pings) [optional]
gRPC load balancing policy for Execution 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]
Config file to specify all options in TOML. [optional]
Download completed action outputs to this path. Leave empty for no download. [optional]
Set a custom digest function. Supported functions: SHA512, SHA384, SHA256, SHA1, MD5 [optional, default = "SHA256"]
Path to working directory. [optional]
Input root digest for Action. [optional]
Input path for Action. --input-path=<path> for each input. Use `local-path:remote-path[:PROPERTIES]` to map an input to a specific path remotely with optional properties. PROPERTIES is a comma-separated list of 'ro', 'rw', 'unix_mode', 'mtime' [optional]
Output path to capture. --output-path=<path> for each output [optional]
A list of keys that indicate what additional file attributes should be captured --output-node-properties=<name> of each property [optional]
Filepath to store stdout [optional]
Filepath to store stderr [optional]
The platform requirements for the execution environment --platform-properties=<key>=<value>,<key>=... for each property [optional]
[Deprecated] Use --env instead [optional]
Environment variables to set in the running program's environment. To specify multiple ones, use `--env=K1=V1 --env=K2=V2 ...` [optional]
The timeout after which the execution of an Action should be killed --exec-timeout=<seconds> [optional]
The priority (relative importance) of this action. A priority of 0 means the *default* priority --priority=<priority> [optional]
Flag indicating that the server should not check the cache when executing an action [optional]
Flag indicating that ActionResults should not be cached, and duplicate Action executions will not be merged [optional]
Follow symlinks when building input trees. If enabled, each input cannot be circular. Enabled by default [optional]
Do not follow symlinks [optional]
An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. --correlated-invocations-id=<str> [optional]
An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. --tool-invocation-id=<str> [optional]
A brief description of the kind of action, for example CppCompile or GoLink. --action-mnemonic=<str> [optional]
An identifier for the target which produced the action that trexe will send. --target-id=<str> [optional]
An identifier for the configuration in which the target was built, to distinguish between e.g. different sets of host tools or different target platforms. --configuration-id=<str> [optional]
Additional string to append to the tool-name (trexe) sent in the metadata. Useful to append additional information about invocation e.x. python to indicate python was used--tool-name=<str> [optional]
Additional string to append to the tool-version (e.x. 0.0.1) sent in the metadata. Useful to append additional information about invocation e.x. 2.3.4 to append 2.3.4 (version of a package named intool-name) to the tool-version metadata--tool-version=<str> [optional]
A hint to the scheduler about the locality of the execution. This is used to schedule the execution on a worker that is close to the data of a previous execution. This only works if the remote scheduler is BuildGrid. [optional]
An optional value to place the `Action` into a separate cache namespace from other instances having the same field contents--salt=<str> [optional]
Flag indicating that trexe should block until execution is complete. This is the default behavior if --operation is not set. [optional]
Flag indicating that trexe should _not_ block until execution is complete. If --operation is not set, this will cause trexe to exit with code 0 upon successful job submission and write the operation id to `stdout` in plaintext (e.g. app-cr/6283a9c6-85b2-4b03-92bd). If --operation is set, this will cause trexe to exit with non-zero code. This is the default if --operation is not set. [optional]
Operation ID to lookup and download outputs from (to the specified directory) if -d is set. [optional]
Cancels the specified operation. Requires --operation. [optional]
The metadata of trexe execution in JSON will be written into this file [optional]
The full action result in JSON will be written into this file [optional]
If not already cached, execute the action in a local BuildBox runner, caching the result [optional]
Runner command for local execution [optional]
Arguments to pass to buildbox-run for local execution This can be useful if the buildbox-run implementation you're using supports non-standard options [optional]
Enables progress logging[optional] [optional]
Enables live streaming of the remote command's stdout/stderr to the local stdout/stderr. [optional]
Use the LocalCAS API for CAS requests. This requires connecting to buildbox-casd. [optional]
Skip uploading to the remote CAS when using the LocalCAS API. This has no effect if `--use-localcas` isn't set. [optional]
The number of threads to hash files to digests. Default=min(hardware-concurrency,16) [optional]
The number of threads for proxy CAS instances to upload or download blobs from/to remote CAS. For now, only upload is parallelized.Default=min(hardware-concurrency*2,32) [optional]
Log level (debug, error, info, trace, warning) [optional, default = "error"]
Set log level to 'debug' [optional]
POSITIONAL [optional]
Metrics Mode: --metrics-mode=MODE - options for MODE are udp://<hostname>:<port> file:///path/to/file stderr [optional]
Metrics publishing interval [optional]
Prefix of metric names [optional]
March 2026 trexe 1.4.0