Quick Start

Get up and running with Codeep in under 5 minutes.

Step 1: Launch Codeep

Navigate to your project directory and start Codeep:

$ cd my-project
$ codeep

Step 2: Select a provider

On first launch, you will see a provider selection screen. Use arrow keys to choose your preferred AI provider and press Enter.

★

If you already have a ANTHROPIC_API_KEY, DEEPSEEK_API_KEY, or other provider key as an environment variable, Codeep will detect and use it automatically — skipping the setup screen.

Step 3: Your first prompt

Type your task in natural language and press Enter:

~ $ codeep
 
  Codeep v2.11.0 · GLM-5.2 · TypeScript project
 
> Add a dark mode toggle to the navbar component

Codeep will read your project structure, find the relevant files, and start working. In Agent Mode (default), it will edit files, run commands, and verify the result automatically.

Useful commands to know

# See all available commands
> /help
 
# Review git changes
> /diff
 
# Generate a commit message
> /commit
 
# Add files to context
> /add src/components/Navbar.tsx
 
# Search sessions
> /search
 
# Change provider or model
> /settings

Agent Mode

By default, Codeep runs in Agent Mode — it autonomously executes a sequence of steps to complete your request. You can watch it work in real-time and approve or reject specific actions.

To disable Agent Mode and use Codeep as a pure chat assistant, run /settings and set Agent Mode to Manual.

ℹ

Codeep automatically saves your session. Use /sessions to browse past conversations and resume where you left off.

Installation Commands