Skip to content

install.md

Latest commit

 

History

History
76 lines (48 loc) · 1.69 KB

install.md

File metadata and controls

76 lines (48 loc) · 1.69 KB
Raw

Installation

English | 日本語

runex ships through multiple channels. Pick the one that fits your platform and tooling.

Cargo (all platforms with a Rust toolchain)

cargo install runex

mise — compile from source

mise use -g cargo:runex

mise — pre-built binary from GitHub releases

No Rust toolchain needed.

mise use -g github:ShortArrow/runex

Homebrew (macOS / Linux)

runex lives in a third-party tap (shortarrow/homebrew-runex). Install it in one line with the fully-qualified name:

brew install shortarrow/runex/runex

…or add the tap first and install with the short name:

brew tap shortarrow/runex
brew install runex

AUR (Arch Linux)

Pre-built binary via runex-bin:

paru -S runex-bin   # or: yay -S runex-bin

winget (Windows)

winget install ShortArrow.runex

Pre-built binary (all platforms)

Each GitHub release ships binaries for:

  • Windows (x86_64)
  • macOS (x86_64 / aarch64)
  • Linux (x86_64 / aarch64)
  • Termux / Android (aarch64)

Download the appropriate archive, extract runex, and place it somewhere on your PATH.

After install

If runex is not found, make sure Cargo's bin directory is on your PATH:

  • Linux/macOS: ~/.cargo/bin
  • Windows: %USERPROFILE%\.cargo\bin

Generated shell scripts and your config.toml are part of your local shell environment. Only load and sync files you trust.

Once runex is on your PATH, continue to setup to wire up shell integration.