Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Requirements

RequirementVersionNotes
Rust1.75+Install via rustup
OSmacOS / LinuxWindows not supported

Quick Install

# Clone and build
git clone https://github.com/Proteusiq/cmd.git
cd cmd
cargo build --release

# Install to local bin
mkdir -p ~/.local/bin
cp target/release/cmd ~/.local/bin/

Add to PATH

If ~/.local/bin isn’t in your PATH, add it:

# For Zsh (~/.zshrc)
export PATH="$HOME/.local/bin:$PATH"

# For Bash (~/.bashrc)
export PATH="$HOME/.local/bin:$PATH"

Then reload your shell:

source ~/.zshrc  # or source ~/.bashrc

Verify Installation

$ cmd --version
cmd 0.5.0

$ cmd --help
Natural language CLI - translate intentions into terminal commands
...

First-Time Setup

After installation, run the setup wizard:

cmd setup

This will:

  1. Let you choose your LLM provider (Claude, OpenAI, Ollama, etc.)
  2. Securely store your API key in the system keychain
  3. Test the connection

Update

To update to the latest version:

cd cmd
git pull
cargo build --release
cp target/release/cmd ~/.local/bin/

Uninstall

# Remove binary
rm ~/.local/bin/cmd

# Remove configuration (optional)
rm -rf ~/.config/cmd

# Remove keychain entries (optional)
cmd config --delete-key anthropic
cmd config --delete-key openai
# Or use Keychain Access on macOS

Troubleshooting

“command not found: cmd”

Make sure ~/.local/bin is in your PATH:

echo $PATH | grep -q '.local/bin' && echo "OK" || echo "Add ~/.local/bin to PATH"

Build errors

Make sure you have the latest Rust:

rustup update

Keychain errors on Linux

Install the Secret Service backend:

# Ubuntu/Debian
sudo apt install libsecret-1-dev gnome-keyring

# Fedora
sudo dnf install libsecret-devel gnome-keyring

# Arch
sudo pacman -S libsecret gnome-keyring

Permission denied

Make sure the binary is executable:

chmod +x ~/.local/bin/cmd