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

Prerequisites

  • Claude Code (the terminal version) must be installed and available in your PATH.

Quick install

Download and extract the archive for your platform from the Itch.io page.

You can use the program portably, but most folks will want to make it available in their PATH.

Commands are provided for this, to put it in the user/system directory and make it easy to invoke.

Windows:

# Install the program to use it from the terminal (restart terminal after) 
# There might be a SmartScreen warning the first time you run this executable 
# In PowerShell:
.\ccode.exe install
# Or in cmd:
ccode.exe install

Linux:

# Install the program to use it from the terminal (restart terminal after)
chmod +x ./ccode
./ccode install

Mac:

# Install the program to use it from the terminal (restart terminal after)
# To avoid Gatekeeper warnings preventing launch (until code signing is set up)
xattr -d com.apple.quarantine ./ccode
chmod +x ./ccode
./ccode install

On macOS, downloaded binaries are quarantined by Gatekeeper - the xattr command above removes this.

The installer will:

  1. Create the install directory
  2. Copy the ccode binary
  3. Add the directory to your PATH

After that, you can launch it from any directory with:

ccode

It also has built in help:

# There's also help if you need it, explaining the current config too
ccode --help
# It does override the claude default, however that help is available directly
claude --help

Install locations

You can also install system-wide with ./ccode install --system (requires admin/sudo).

Depending on how you run the install command, where the app ends up will change:

ModeWindowsLinux / macOS
User (default)%LOCALAPPDATA%\Programs\ccode\~/.local/bin/
System (--system)C:\Program Files\ccode\/usr/local/bin/

After installing, restart your terminal and run the tool to create your configuration file.

Uninstalling

To remove ccode from your system:

ccode uninstall

This will check both user-level and system-level install locations for binaries, offer to clean up PATH entries, and offer to remove the configuration directory. You are prompted before each deletion - nothing is removed without your confirmation.

You can run the uninstall from the installed binary itself (it handles self-deletion).

Manual install

If you prefer to install manually, download and extract the archive, then:

Windows

mkdir "C:\Program Files\ccode"
copy ccode.exe "C:\Program Files\ccode\ccode.exe"
# Add C:\Program Files\ccode to your system PATH via:
# Settings > System > About > Advanced System Settings > Environment Variables

Linux / macOS

sudo cp ccode /usr/local/bin/ccode
sudo chmod +x /usr/local/bin/ccode

First-time setup

Here’s the setup process as an all-in-one reference with some alternative commands:

# You can install the program to use it from the terminal
# On Mac, remove the Gatekeeper quarantine attribute (until code signing is set up)
xattr -d com.apple.quarantine ./ccode
# Need to make it executable on some platforms
chmod +x ./ccode
# On Windows, there might be a SmartScreen warning the first time you run this executable
# Install for the local user
./ccode install
# Optional: Install for the system-wide user (requires sudo on some platforms)
./ccode install --system

# Create the config file with examples 
# (running ccode with no args also does the same)
ccode init-config
# You can also initialize a minimal one, without all the examples
ccode init-config --minimal

# Optional: You can also reset them to the defaults in case you want to wipe the config
ccode init-config --reset
ccode init-config --reset --minimal

# Then edit the configuration file to fill in the providers you want to use
# (you can specify whatever editor you prefer, if not using the default)
ccode edit-config
ccode edit-config vim
ccode edit-config nano
ccode edit-config zed

# Edit the config to add your API keys for whatever providers you want, setup is done