Skip to content

Installation

Requirements

  • Python 3.11+
  • macOS or Linux (Windows support is planned)
  • uv — fast Python package manager (installed automatically by the installer)

If you use Claude Code, install Crux as a plugin:

claude plugin marketplace add crux-cli/claude-marketplace
claude plugin install crux

The plugin auto-installs the crux CLI on your first session. It also provides the Crux skill so Claude knows all available commands.

Alternative: Curl Installer

The fastest way to install Crux without the plugin:

curl -LsSf https://raw.githubusercontent.com/crux-cli/crux/main/install.sh | sh

The installer:

  1. Checks for uv and installs it if missing
  2. Installs crux-cli from PyPI via uv tool install
  3. Initializes ~/.crux/ directory structure
  4. Installs the bundled Crux skill for Claude Code
  5. Reports any missing dependencies and next steps

Alternative: Manual Install with uv

If you already have uv installed:

uv tool install crux-cli
crux init

Alternative: pip

pip install crux-cli
crux init

Verify Installation

crux version

Check your environment is healthy:

crux doctor

crux doctor validates your directory structure, config files, dependencies, and auto-fixes what it can.

Upgrading

curl -LsSf https://raw.githubusercontent.com/crux-cli/crux/main/install.sh | sh

uv tool upgrade crux-cli

pip install --upgrade crux-cli

Check for updates without installing:

crux version --check

Uninstalling

uv tool uninstall crux-cli
rm -rf ~/.crux  # Remove all data