Installation
Choose the installation method that works best for your system.
Quick Install (Recommended)
Section titled “Quick Install (Recommended)”The fastest way to install rung on macOS or Linux:
curl -sSf https://rungstack.com/install.sh | shThis script automatically detects your platform and installs the latest version.
Options
Section titled “Options”Custom install directory (defaults to /usr/local/bin or ~/.local/bin):
INSTALL_DIR=~/bin curl -sSf https://rungstack.com/install.sh | shWindows
Section titled “Windows”Download the .zip from releases and add to your PATH.
Homebrew (macOS/Linux)
Section titled “Homebrew (macOS/Linux)”brew tap auswm85/tapbrew install rungInstalled from the previous tap (auswm85/rung)? Switch to the shared tap:
brew uninstall rungbrew untap auswm85/rungbrew tap auswm85/tapbrew install rungFrom crates.io
Section titled “From crates.io”If you have Rust installed:
cargo install rung-cliWith cargo-binstall
Section titled “With cargo-binstall”Faster installation without compilation:
cargo binstall rung-cliFrom Source
Section titled “From Source”Clone and build from the repository:
git clone https://github.com/auswm85/rungcd rungcargo install --path crates/rung-cliVerify Installation
Section titled “Verify Installation”After installation, verify rung is available:
rung --versionYou should see output like:
rung 0.1.0Requirements
Section titled “Requirements”- Git 2.x — rung uses git2-rs for git operations
- A forge credential for your remote:
- GitHub — GitHub CLI (
gh) authenticated, orGITHUB_TOKENenvironment variable - GitLab — GitLab CLI (
glab) authenticated, orGITLAB_TOKENenvironment variable
- GitHub — GitHub CLI (
Setting up GitHub Authentication
Section titled “Setting up GitHub Authentication”rung needs GitHub access to create and manage pull requests. You have two options:
Option 1: GitHub CLI (Recommended)
Section titled “Option 1: GitHub CLI (Recommended)”Install and authenticate the GitHub CLI:
# Install gh (if not already installed)brew install gh # macOSapt install gh # Ubuntu/Debianwinget install gh # Windows
# Authenticategh auth loginOption 2: Personal Access Token
Section titled “Option 2: Personal Access Token”Set the GITHUB_TOKEN environment variable:
export GITHUB_TOKEN=ghp_your_token_hereYour token needs these scopes:
repo— Full control of private repositoriesread:org— Read org membership (if using organization repos)
Setting up GitLab Authentication
Section titled “Setting up GitLab Authentication”For GitLab remotes (gitlab.com or self-hosted), rung needs GitLab access to create and manage merge requests. You have two options:
Option 1: GitLab CLI (Recommended)
Section titled “Option 1: GitLab CLI (Recommended)”Install and authenticate the GitLab CLI:
# Install glab (if not already installed)brew install glab # macOSapt install glab # Ubuntu/Debianwinget install glab # Windows
# Authenticateglab auth loginOption 2: Personal Access Token
Section titled “Option 2: Personal Access Token”Set the GITLAB_TOKEN environment variable:
export GITLAB_TOKEN=glpat_your_token_hereYour token needs the api scope.
For self-hosted GitLab, also set gitlab.api_url in .git/rung/config.toml so rung can detect and reach your instance — see Configuration.
Next Steps
Section titled “Next Steps”Once installed, head to the Quick Start guide to create your first stack.
