BUILDBOX-RUN-HOSTTOOLS(1)

πŸ“¦
version 1.4.16 Β· 2 versions
, in ubuntu stonking

πŸ¦‹ NAME πŸ¦‹

buildbox-run-hosttools β€” and that's it, bestie. the name is the name, the description is the name, it's giving "I contain multitudes" but the multitudes are just itself. periodt. πŸ’…

🌸 DESCRIPTION 🌸

okay so, first things first, here's exactly how you call this thing:

usage: debian/buildbox/usr/bin/buildbox-run-hosttools [OPTIONS]

that's the path it lives at, and you hand it some OPTIONS and it goes to work. no cap. 🫢

and now, the part you actually came for β€” every single flag, and I mean every single one, because we do not skip options in this house. not one. not ever. 😀✨

πŸŽ€ OPTIONS πŸŽ€

  • --help β€” print this message and exit. the "hello, what are you" button. πŸ’–
  • --version β€” print version information and exit. the "who even are you" button.
  • --action=PATH β€” path to read the input Action from. this is where your Action is coming from, bestie.
  • --action-result=PATH β€” path to write the output ActionResult to. where it goes when it's done.
  • --log-level=LEVEL β€” default is info. log verbosity, and your options are trace / debug / info / warning / error. pick your chaos level. 🌈
  • --verbose β€” sets the log level to debug. basically turning on the subtitles. πŸ™ˆ
  • --digest-function β€” set digest function.
  • --log-directory=DIR β€” write logs to this directory, with filenames formatted like:
debian/buildbox/usr/bin/buildbox-run-hosttools.<hostname>.<username>.log.<severity level>.<date>.<time>.<pid>

like yes it's a whole paragraph of a filename, but that's the format, so we respect it. πŸŽ€

  • --disable-localcas β€” do not use LocalCAS protocol methods.
  • --workspace-path=PATH β€” the location on disk the runner will use as root when it's executing jobs. its home base. 🏠
  • --stdout-file=FILE β€” file to redirect the command's stdout to.
  • --stderr-file=FILE β€” file to redirect the command's stderr to.
  • --no-logs-capture β€” do not capture and upload the contents written to stdout and stderr. letting them run free. πŸ¦‹
  • --collect-execution-stats β€” gather execution_stats.proto metrics and attach the digest of the message in CAS to ActionResult.execution_metadata.auxiliary_metadata. numbers girlies rise. πŸ“Š
  • --validate-parameters β€” only check whether all the required parameters are being passed and that no unknown options are given. exits with a status code containing the result (0 if successful). a quick vibe check before the real thing. ✨
  • --post-action-command=COMMAND β€” command to run after the action is done. it can take one parameter, which is the path to the staged directory. these commands are blocking if --disable-localcas is set. πŸ‘€
  • --output-bypass-local-cache β€” skip caching output blobs in the LocalCAS storage when using the LocalCAS API. this has no effect if --disable-localcas is set. so don't bother, bestie.
  • --staging-mode=MODE β€” specify how to stage directories and files when handling StageTreeRequest. valid values are: [fuse, copy-or-link, default], where default would favor fuse if it is available. choosing your fighter. πŸ₯Š
  • --graceful-shutdown-seconds=SECONDS β€” how long to wait after sending a SIGTERM to the executed command due to a timeout or runner shutdown. by default a SIGKILL is sent immediately. so yeah β€” default is no mercy. πŸ’€
  • --remote=URL β€” URL for the CAS service.
  • --instance=NAME β€” name of the CAS instance.
  • --server-cert=PATH β€” public server certificate for TLS (PEM-encoded).
  • --client-key=PATH β€” private client key for TLS (PEM-encoded). keep it secret, keep it safe. πŸ”
  • --client-cert=PATH β€” public client certificate for TLS (PEM-encoded).
  • --access-token=PATH β€” access Token for authentication (e.g. JWT, OAuth access token, etc), will be included as an HTTP Authorization bearer token.
  • --token-reload-interval=MINUTES β€” time to wait before refreshing the access token from disk again. the following suffixes can be optionally specified: M (minutes), H (hours). value defaults to minutes if the suffix isn't specified. ⏰
  • --googleapi-auth β€” use GoogleAPIAuth when this flag is set.
  • --credential-helper=PATH β€” path to credential helper executable for dynamic authentication. example: --credential-helper=/usr/bin/helper
  • --retry-limit=INT β€” number of times to retry on grpc errors.
  • --retry-delay=MILLISECONDS β€” how long to wait before the first grpc retry.
  • --retry-on-code β€” which gRPC status code(s) to retry on.
  • --request-timeout=SECONDS β€” how long to wait for gRPC request responses.
  • --min-throughput=BPS β€” minimum throughput in bytes per second. the value may be suffixed with K, M, G or T. speed limits but make it ✨
  • --keepalive-time=SECONDS β€” the period after which a keepalive ping is sent.
  • --load-balancing-policy β€” which grpc load balancing policy to use. valid options are 'round_robin' and 'grpclb'.
  • --ra-remote=URL β€” URL for the Asset service.
  • --ra-instance=NAME β€” name of the Asset instance.
  • --ra-server-cert=PATH β€” public server certificate for TLS (PEM-encoded).
  • --ra-client-key=PATH β€” private client key for TLS (PEM-encoded).
  • --ra-client-cert=PATH β€” public client certificate for TLS (PEM-encoded).
  • --ra-access-token=PATH β€” access Token for authentication (e.g. JWT, OAuth access token, etc), will be included as an HTTP Authorization bearer token.
  • --ra-token-reload-interval=MINUTES β€” time to wait before refreshing the access token from disk again. the following suffixes can be optionally specified: M (minutes), H (hours). value defaults to minutes if the suffix isn't specified.
  • --ra-googleapi-auth β€” use GoogleAPIAuth when this flag is set.
  • --ra-credential-helper=PATH β€” path to credential helper executable for dynamic authentication. example: --credential-helper=/usr/bin/helper
  • --ra-retry-limit=INT β€” number of times to retry on grpc errors.
  • --ra-retry-delay=MILLISECONDS β€” how long to wait before the first grpc retry.
  • --ra-retry-on-code β€” which gRPC status code(s) to retry on.
  • --ra-request-timeout=SECONDS β€” how long to wait for gRPC request responses.
  • --ra-min-throughput=BPS β€” minimum throughput in bytes per second. the value may be suffixed with K, M, G or T.
  • --ra-keepalive-time=SECONDS β€” the period after which a keepalive ping is sent.
  • --ra-load-balancing-policy β€” which grpc load balancing policy to use. valid options are 'round_robin' and 'grpclb'.
  • --nested-instance=NAME β€” instance to use for nested remote execution.
  • --nested-ac-enable-update β€” allow action cache updates for nested remote execution.
  • --action-digest-env=VAR_NAME β€” set the action digest in the specified environment variable.
  • --allow-executable=ALLOWED_EXECUTABLE_PATH β€” only commands which run this executable are allowed. a very exclusive guest list. πŸ‘‘
  • --clearenv β€” unset all environment variables. scorched earth, bestie. πŸ”₯
  • --env-file=PATH β€” replace environment with the contents of the specified file.

and that's the whole entire page, no detail left behind, as promised. πŸ’– this little icon is buildbox-run-hosttools version 1.4.16, dated August 2026, and it lives its best life in the BUILDBOX-RUN-HOSTTOOLS(1) manual. go forth and run those host tools, bestie β€” you're gonna slay. πŸ’…βœ¨πŸ«Ά

πŸ“¦ where this page comes from