Installing and running Toolproof

Toolproof is a static binary with no dynamic dependencies, so in most cases will be simple to install and run. Toolproof is currently supported on Windows, macOS, and Linux distributions.

#Ensuring Toolproof is running a supported version

For all installation methods, your Toolproof configuration can specify the supported Toolproof versions.

# In toolproof.yml
supported_versions: ">=0.10.3"

This can also be set in a TOOLPROOF_SUPPORTED_VERSIONS environment variable.

#Running via npx

npx toolproof

Toolproof publishes a wrapper package through npm, which is the easiest way to get started. This package will download the correct binary of the latest release as an npm dependency for your platform and run it.

Specific versions can be run by passing a version tag:

npx toolproof@latest

npx toolproof@v0.1.0

#Downloading a precompiled binary

If you prefer to install Toolproof yourself, you can download a precompiled release from GitHub and run the binary directly:

./toolproof

#Building from source

If you have Rust and Cargo installed, you can run cargo install toolproof to build from source.

cargo install toolproof
toolproof