Home / Getting Started

📦 Installation

Get Code Puppy up and running in just a few minutes! Choose the installation method that works best for you.

Requirements

Using uvx (Recommended)

The fastest way to run Code Puppy without installing anything permanently:

uvx code-puppy

This uses uv, the blazingly fast Python package manager.

💡 Don't have uv?

Install it with: curl -LsSf https://astral.sh/uv/install.sh | sh

Using pip

Install Code Puppy globally or in a virtual environment:

# Global installation
pip install code-puppy

# Then run it
code-puppy

Using pipx

For isolated installation that won't conflict with other packages:

pipx install code-puppy
code-puppy

From Source

For development or to get the latest features:

# Clone the repository
git clone https://github.com/mpfaffenberger/code_puppy.git
cd code-puppy

# Install dependencies with uv
uv sync

# Run Code Puppy
uv run code-puppy

Setting Up API Keys

Code Puppy needs API keys to connect to AI providers. You have two options:

Option 1: Using the /set Command (Recommended)

The easiest way to configure API keys is using the /set command inside Code Puppy:

# OpenAI
/set openai_api_key sk-your-key-here

# Anthropic (Claude)
/set anthropic_api_key sk-ant-your-key-here

# Google (Gemini)
/set google_api_key your-key-here

# Cerebras
/set cerebras_api_key your-key-here

# Mistral
/set mistral_api_key your-key-here

# Groq
/set groq_api_key your-key-here
✅ Keys are saved automatically

The /set command saves your API keys to ~/.code_puppy/puppy.cfg, so they persist across sessions. No need to set environment variables!

Option 2: Environment Variables

Alternatively, you can set API keys as environment variables:

# OpenAI
export OPENAI_API_KEY="sk-your-key-here"

# Anthropic (Claude)
export ANTHROPIC_API_KEY="sk-ant-your-key-here"

# Google (Gemini)
export GOOGLE_API_KEY="your-key-here"

# Cerebras
export CEREBRAS_API_KEY="your-key-here"

# Mistral
export MISTRAL_API_KEY="your-key-here"

# Groq
export GROQ_API_KEY="your-key-here"
⚠️ Tip

Add these exports to your ~/.bashrc or ~/.zshrc to make them persistent.

Verify Installation

After installation, verify everything is working:

# Start Code Puppy
code-puppy

# You should see the welcome message with a bouncing puppy! 🐶
# Try typing:
/help

Next Steps