Skip to content

Installation

Bash YOLO

bash
curl -fsSL https://raw.githubusercontent.com/raine/workmux/main/scripts/install.sh | bash

Homebrew (macOS/Linux)

bash
brew install raine/workmux/workmux

Cargo

Requires Rust. Install via rustup if you don't have it.

bash
cargo install workmux

Nix

Requires Nix with flakes enabled.

bash
nix profile install github:raine/workmux

Or try without installing:

bash
nix run github:raine/workmux -- --help

See Nix guide for flake integration and home-manager setup.


For manual installation, see pre-built binaries.

For faster typing, alias workmux to wm:

bash
alias wm='workmux'

Add this to your .bashrc, .zshrc, or equivalent shell configuration file.

Shell completions

To enable tab completions for commands and branch names, add the following to your shell's configuration file.

bash
# Add to ~/.bashrc
eval "$(workmux completions bash)"
bash
# Add to ~/.zshrc
eval "$(workmux completions zsh)"
bash
# Add to ~/.config/fish/config.fish
workmux completions fish | source

Released under the MIT License.