Installation

Bash YOLO

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

Homebrew (macOS/Linux)

brew install raine/workmux/workmux

Other methods

Cargo

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

cargo install workmux

mise

mise use -g cargo:raine/workmux

Nix

Requires Nix with flakes enabled.

nix profile install github:raine/workmux

Or try without installing:

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

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

---

For manual installation, see pre-built binaries.

Shell alias (recommended)

For faster typing, alias workmux to wm:

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)"

Zsh

# Add to ~/.zshrc
eval "$(workmux completions zsh)"

Fish

# Add to ~/.config/fish/config.fish
workmux completions fish | source

Uninstalling

Automatic (recommended)

Run the uninstall script:

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

If installed via Homebrew, also run:

brew uninstall workmux
brew untap raine/workmux

If installed via Cargo, also run:

cargo uninstall workmux

Manual

1. Remove hooks, skills, cache and state by running the uninstall script, or delete workmux data directly: rm -rf ~/.cache/workmux ~/.local/state/workmux
2. Remove the binary from /usr/local/bin, ~/.local/bin, or ~/.cargo/bin
3. Optionally remove config: rm -rf ~/.config/workmux
4. Remove shell completions and alias wm=workmux from your shell config
5. Clean up worktrees with git worktree list / git worktree remove