Installing and running Toolproof

#Running via npx (Recommended)

The easiest way to get started is through npm:

npx toolproof

This wrapper package downloads the correct binary for your platform and runs it.

You can specify versions with:

npx toolproof@latest
npx toolproof@v0.1.0

#Downloading a Precompiled Binary

You can download a precompiled release from GitHub and run it directly:

./toolproof

#Building from Source

If you have Rust and Cargo installed:

cargo install toolproof
toolproof

#Browser Requirements

For browser testing functionality, Toolproof requires Chrome, Chromium, or Microsoft Edge to be installed on your system. See the Browser Testing page for detailed installation and configuration requirements.

#Basic Usage

# Run all tests
npx toolproof

# Run in interactive mode (for updating snapshots)
npx toolproof -i

# Run a specific test
npx toolproof --name "My Test Name"

# See all options
npx toolproof --help

#Ensuring Compatible Versions

You can specify supported Toolproof versions in your configuration:

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

This can also be set with the TOOLPROOF_SUPPORTED_VERSIONS environment variable.

#Additional Options

For a complete list of command-line options, environment variables, and configuration settings, see the Configuration and Options page.