README
¶
[!IMPORTANT] Previously used
tusk-drift-cli? This repo has moved totusk-cli, and older installed CLI versions may not auto-update across the rename. Please reinstall using the current install instructions below.
The Tusk CLI provides tools for automated testing workflows. It supports two products:
- Tusk Drift - Live traffic record/replay as API tests
- Tusk Unit - Automated unit tests
Tusk Drift — API Record/Replay Testing
Record real API traffic and replay it as deterministic tests. Works locally and in CI/CD with Tusk Drift Cloud.
tusk drift setup # AI setup agent
tusk drift run # Replay recorded traces
tusk drift run --cloud # Run against Tusk Drift Cloud
Tusk Unit — Automated Unit Tests
View, review, and apply unit tests from Tusk directly from your terminal or automation pipeline.
tusk unit latest-run # Latest run for current branch
tusk unit get-run <run-id> # Full run details
tusk unit get-diffs <run-id> # Get diffs to apply
Install
Quick install (recommended)
Linux/macOS:
Install the latest version:
curl -fsSL https://cli.usetusk.ai/install.sh | sh
To install a specific version:
curl -fsSL https://cli.usetusk.ai/install.sh | sh -s -- v1.2.3
Linux additional dependencies (for replay sandboxing):
- Debian/Ubuntu:
sudo apt install bubblewrap socat - Fedora/RHEL:
sudo dnf install bubblewrap socat - Arch:
sudo pacman -S bubblewrap socat
Without these, sandboxing is disabled and replays run without network isolation. See Architecture - Sandboxing.
Homebrew:
brew tap use-tusk/tap
brew install use-tusk/tap/tusk
To update:
brew upgrade use-tusk/tap/tusk
Windows:
We recommend using WSL for the best experience on Windows. With WSL, you can use the Linux/macOS installation steps above and avoid Windows-specific configuration. For native Windows installation without WSL, expand below to see the steps.
Installation steps
Download the latest release from [GitHub Releases](https://github.com/Use-Tusk/tusk-cli/releases/latest):-
Download
tusk-cli_*_Windows_x86_64.zip(orarm64for ARM-based Windows) -
Extract the ZIP file
-
Move
tusk.exeto a directory in your PATH (e.g.,C:\tools\), or add the extracted directory to your PATH:Option A: Add to PATH via PowerShell (run as Administrator):
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\path\to\tusk", "User")Option B: Add to PATH via System Settings:
- Press
Win + R, typesysdm.cpl, press Enter - Click "Environment Variables"
- Under "User variables", select
Pathand click "Edit" - Click "New" and add the folder containing
tusk.exe - Click OK to save
- Press
-
Restart your terminal and verify:
tusk --version
Note: Windows requires additional configuration for running tests. See Windows Support for details on TCP communication mode setup.
Manual Download
Download pre-built binaries from GitHub Releases.
Build from source
# Go 1.25+
git clone https://github.com/Use-Tusk/tusk-cli.git
cd tusk-cli
make deps
make build
tusk --help
Community
Join our open source community on Slack.
Development
See CONTRIBUTING.md.
License
See LICENSE.
Documentation
¶
There is no documentation for this package.
Source Files
Directories