deptool

deptool [--version] [-h | --help] <command> [<args>]

Description

The deptool executable, see the commands for more details. The two commands to get started:

init
Create an empty store in the current directory.
deploy
Deploy a config tree to the cluster.

Additional commands:

diff
Show the full diff that would be applied by the next deploy.
ping
Measure round-trip latency to each host.
sync
Fetch the latest cluster state.
status
Show per-host deployment status, computed offline.

Environment

The following environment variables affect Deptool’s behavior:

DEPTOOL_BIN_DIR

For cross-platform deploys, where the target host is a different platform than the operator machine (for example, deploying against a Linux x86_64 host from a OpenBSD arm64 host), Deptool needs a deptool binary for the target platform. It looks for those binaries in DEPTOOL_BIN_DIR, in subdirectories named after the target platform (uname -sm output lowercased and spaces replaced with dashes, e.g. linux-x86_64). When this variable is not set, Deptool falls back to:

  • $XDG_CACHE_HOME/deptool, if XDG_CACHE_HOME is set.
  • $HOME/.cache/deptool

DEPTOOL_STORE

Path to the store, by default .deptool in the current directory.

NO_COLOR

Setting this variable to a non-empty string inhibits colored output, according to the NO_COLOR standard.