CodeepCodeep

Installation

Codeep runs on macOS, Linux, and Windows (via WSL). It requires Node.js 20 or later. Choose the install method that works best for you.

Codeep running in the terminal (TUI)
Codeep in the terminal — the full agent in your shell

Requirements

  • ✓Node.js 20 or later
  • ✓npm 9 or later (included with Node.js)
  • ✓Terminal: zsh, bash, fish, or PowerShell
  • ✓API key for at least one supported AI provider

Option 1: curl (Recommended)

One-line installer for macOS and Linux:

$ curl -fsSL https://raw.githubusercontent.com/VladoIvankovic/Codeep/main/install.sh | bash

The install script automatically detects your platform, installs the latest version, and verifies the installation.

Option 2: npm

# Install globally
$ npm install -g codeep
 
# Verify installation
$ codeep --version
1.2.92

Option 3: Homebrew (macOS)

$ brew tap VladoIvankovic/codeep
$ brew install codeep

Updating

# Via npm
$ npm update -g codeep
 
# Via Homebrew
$ brew upgrade codeep

First run

After installation, navigate to your project folder and run:

$ cd your-project
$ codeep

On first launch, Codeep will ask you to select an AI provider and enter your API key. The key is stored securely in your system keychain.

★
You can set your API key via environment variable to skip the prompt:
export ANTHROPIC_API_KEY=sk-...
IntroductionQuick Start