Skip to content
Kodel.AI Docs

Quick Start

import { Steps, Aside } from ‘@astrojs/starlight/components’;

Get Kodel.AI running locally in under 5 minutes.

Prerequisites

Section titled “Prerequisites”
  • Docker and Docker Compose installed
  • An API key from OpenAI, Anthropic, or any compatible provider

Setup

Section titled “Setup”

  1. Clone the repository

    Terminal window
    git clone https://github.com/kodel-ai/kodel
    cd kodel

  2. Create your environment file

    Terminal window
    cp .env.example .env

    Open .env and set your LLM API key:

    Terminal window
    OPENAI_API_KEY=sk-...

  3. Start the stack

    Terminal window
    docker compose up -d

    This starts PostgreSQL, ClickHouse, the server, and one agent container.

  4. Create your first user

    Terminal window
    bun run scripts/dev-auth.ts

    This creates dev@kodel.test / Dev1234! and prints an auth token.

  5. Open the UI

    Navigate to http://localhost:3000 and log in.

Your first task

Section titled “Your first task”
  1. Create a Project and link it to a git repository
  2. Open the Board and create a task: “Add a hello world endpoint”
  3. Click Run Agent — watch it write code in real time
  4. Review the generated pull request

What’s next

Section titled “What’s next”