Installation¶

This guide covers how to install CMDR on your system.

Prerequisites¶

A Unix-like operating system (Linux, macOS)
Bash, Zsh, or compatible shell
curl for script installation

Quick Install (Recommended)¶

Run the following command to install the latest version of CMDR:

curl -o- https://raw.githubusercontent.com/MrLYC/cmdr/master/install.sh | ${SHELL:-bash}

For Users in China¶

Speed up the installation using the proxy option:

curl -o- https://raw.githubusercontent.com/MrLYC/cmdr/master/install.sh | bash -s -p

Manual Installation¶

If you prefer manual installation or need more control:

Download the latest release from GitHub Releases
Make the binary executable:
```
chmod +x /path/to/cmdr
```
Initialize CMDR:
```
/path/to/cmdr init
```
Restart your shell and verify:
```
cmdr version
```

What the Installer Does¶

The installation script performs these steps¹:

Detects your OS and architecture
Downloads the appropriate binary from GitHub releases
Places the binary in a configured location
Runs cmdr init to set up the environment
Configures the shell profile for PATH integration

Directory Structure¶

After installation, CMDR creates the following directory structure²:

~/.cmdr/
├── bin/           # Managed command binaries
├── shims/         # Shim scripts for version switching
├── profile/       # Shell initialization scripts
├── config.yaml    # Configuration file
└── cmdr.db        # Command database

Verifying Installation¶

After installation, verify everything is working:

# Check CMDR version
cmdr version

# Check system status
cmdr doctor

Uninstalling¶

To uninstall CMDR:

Remove the CMDR directory:
```
rm -rf ~/.cmdr
```
Remove the CMDR source line from your shell profile (.bashrc, .zshrc, etc.)

Installation script: install.sh ↩
Default paths configured in cmd/root.go L73-L77 ↩