Installation

From Source (Recommended)

Requires Go 1.25+ installed.

git clone https://github.com/roygabriel/crux.git
cd crux
make build

The binary is at bin/crux. Copy it to your PATH:

sudo install -m 755 bin/crux /usr/local/bin/crux

Or use the install target:

sudo make install

go install github.com/roygabriel/crux/cmd/crux@latest

curl -fsSL https://raw.githubusercontent.com/roygabriel/crux/main/scripts/install.sh | sh

Override the install directory:

INSTALL_DIR=~/.local/bin curl -fsSL https://raw.githubusercontent.com/roygabriel/crux/main/scripts/install.sh | sh

Crux requires tmux to be installed and available in your PATH. Install it with your system package manager:

# Debian / Ubuntu
sudo apt install tmux

# macOS
brew install tmux

# Arch Linux
sudo pacman -S tmux

Generate and install shell completions for tab-completion of commands and flags.

# Source for current session
source <(crux completion bash)

# Install permanently
crux completion bash > /etc/bash_completion.d/crux

# Ensure completions are enabled in ~/.zshrc:
# autoload -U compinit; compinit

crux completion zsh > "${fpath[1]}/_crux"

crux completion fish | source

# Install permanently
crux completion fish > ~/.config/fish/completions/crux.fish

crux completion powershell | Out-String | Invoke-Expression

Generate and install man pages:

make man
sudo make install-man

Then access with man crux.

crux --version
crux --help