Skip to content
GitHub

Installation Guide

This guide will walk you through the different ways to install runy on your system.

There are three primary ways to install runy:

The easiest way to install runy is using our installation script:

curl --proto '=https' --tlsv1.2 -sLSf https://sh.runy.dev | sh

This script will:

  • Detect your operating system and architecture
  • Download the appropriate binary for your system
  • Install runy to your local bin directory
  • Add runy to your PATH

If you’re using macOS or Linux and prefer using Homebrew, you can install runy from our tap:

brew tap runy-dev/runy
brew install runy

You can also download the pre-compiled binaries directly from our GitHub releases page:

  1. Go to the runy releases page
  2. Download the appropriate archive for your system:
    • runy-x86_64-apple-darwin.tar.xz - macOS (Intel)
    • runy-aarch64-apple-darwin.tar.xz - macOS (Apple Silicon)
    • runy-x86_64-unknown-linux-gnu.tar.xz - Linux (glibc)
    • runy-x86_64-unknown-linux-musl.tar.xz - Linux (musl)
  3. Extract the archive and move the runy binary to a directory in your PATH

Example for macOS:

# Download and extract (replace with your architecture)
curl -L -o runy.tar.xz https://github.com/s-panferov/runy/releases/latest/download/runy-aarch64-apple-darwin.tar.xz
tar -xf runy.tar.xz

# Move to a directory in your PATH
sudo mv runy /usr/local/bin/

After installation, verify that runy is working correctly:

runy --version

You should see the version number of runy printed to your terminal.

runy uses Watchman for efficient file watching. You’ll need to install Watchman separately:

Now that you have runy installed, you can start using it to run tasks in your projects. Check out our other guides to learn more about runy’s features and capabilities.