CodePilot
Getting Started

Requirements

System requirements and prerequisites for running CodePilot locally or in production.

CodePilot requires several runtime dependencies and services to operate. This page lists all requirements for both development and production environments.

System Requirements

RequirementMinimumRecommended
CPU4 cores8+ cores
RAM8 GB16+ GB
Disk20 GB free50+ GB free
OSmacOS, Linux, Windows (WSL2)macOS or Linux

Why high RAM?

Ollama loads AI models into memory. The qwen2.5:7b model alone requires ~4.4 GB of RAM. Running all three models concurrently benefits from 16 GB or more.

Runtime Dependencies

Node.js

Node.js 20 or later is required. We recommend using a version manager:

nvm install 20
nvm use 20
fnm install 20
fnm use 20
volta install node@20

pnpm

pnpm 10 or later is required for workspace management:

corepack enable
corepack prepare pnpm@latest --activate

Docker & Docker Compose

Docker is used to run PostgreSQL and Redis in development, and all services in production.

Verify the installation:

docker --version
docker compose version

Ollama

Ollama runs AI models locally. Install it from ollama.ai/download.

After installation, pull the required models:

ollama pull nomic-embed-text    # Embeddings (required)
ollama pull qwen2.5-coder:3b    # Chat & code review (required)
ollama pull qwen2.5:7b           # Repository intelligence (optional)

GitHub App

For GitHub OAuth and webhook integration, you need a GitHub App. See Authentication for setup instructions.

Services

CodePilot depends on the following services, all of which are provided via Docker Compose:

ServiceImageDefault PortPurpose
PostgreSQLpgvector/pgvector:pg185432Primary database with vector support
Redisredis/redis-stack:latest6379Job queue (BullMQ) and caching
RedisInsight(included in Redis Stack)8001Redis GUI for monitoring

Network Ports

Ensure these ports are available on your machine:

PortService
3000Next.js frontend
3001Documentation site
5432PostgreSQL
6379Redis
8001RedisInsight
8080Express API
11434Ollama

On this page