Skip to content

Installation

The fastest way to get started. The script auto-detects your OS and architecture, downloads the correct binary, and adds it to your PATH.

Linux / macOS
curl -fsSL https://suirunner.vercel.app/install.sh | bash
Windows — PowerShell
irm https://suirunner.vercel.app/install.ps1 | iex

After installation, open a new terminal (or reload your shell config) and verify:

Terminal window
sui-runner --help

The install script only handles the sui-runner binary itself. You also need these tools in your PATH:

ToolWhy
Sui CLIRequired for all Move operations
GitRequired for fetching Move package dependencies
Cargo (Rust)Required only if building from source

Run sui-runner check after installation to confirm everything is in place.

Pre-built binaries are available on the GitHub Releases page:

PlatformAsset
Linux x86_64sui-runner-linux-x86_64.tar.gz
macOS ARM (Apple Silicon)sui-runner-macos-aarch64.tar.gz
macOS x86_64sui-runner-macos-x86_64.tar.gz
Windows x86_64sui-runner-windows-x86_64.zip

Linux / macOS

Terminal window
tar -xzf sui-runner-<os>-<arch>.tar.gz
sudo mv sui-runner /usr/local/bin/

Windows

Extract the .zip and move sui-runner.exe to a directory on your PATH.

target/release/sui-runner
git clone https://github.com/MikeyA-yo/sui-runner.git
cd sui-runner
cargo build --release