docs
v0.8.2
Docs Getting Started Introduction

Introduction

Codality is a self-hosted AI coding agent. You write tickets, it writes code, commits, and opens pull requests. It runs on your server with your API keys.

What Codality does

Codality is a project management tool with an embedded AI agent. You create tickets describing work. The agent reads your codebase, implements changes, runs tests, commits, and pushes. If you have GitHub integration enabled, it creates pull requests and responds to CI failures and review feedback automatically.

The core loop:

  1. You write a ticket describing what needs to change
  2. The agent reads the codebase and implements the change
  3. You review the work (locally or via GitHub PR)
  4. The code merges into your main branch

Key features

  • Ticket tracker — Create, prioritize, and manage development tickets with status workflows
  • AI agent — Autonomous coding agent that reads your code, makes changes, runs tests, and commits
  • Collaborative planning — AI-assisted planning documents that generate structured tickets
  • GitHub integration — Automatic PR creation, CI feedback response, review handling, and webhook-driven workflows
  • Code browser — Browse your repository and request AI changes to specific files
  • Discovery & work queues — Conversational AI for exploring codebases, then creating ordered ticket queues for autonomous sequential execution
  • Docker sandbox — Agent commands run inside isolated Docker containers with resource limits and persistent toolchains
  • Configurable prompts — Full control over the agent's system prompt, priorities, and methodology per ticket kind
  • Multi-user — OTP-based authentication with admin and member roles
  • Git identity & SSH keys — Per-user git identity and auto-generated SSH keys for push authentication

How it works

Codality is a single binary. It embeds a web UI and serves everything from one process. Data is stored in SQLite. The agent uses the OpenAI API (or compatible endpoints) for reasoning and code generation.

Each ticket gets its own git worktree. The agent works in isolation without touching your main branch until changes are approved or merged via PR.

Prerequisites

Before installing Codality you need:

  • A Linux server (x86_64 or arm64)
  • An OpenAI API key — the agent uses this for all AI operations
  • A SendGrid API key — used for sending OTP login emails (free tier works)
  • A SendGrid verified sender email — a verified sender in your SendGrid account
  • A Tavily API key — powers the agent's web search and content extraction tools (free tier at tavily.com)
  • A domain name pointed at your server (for HTTPS)

Recommended: Docker installed and running. The agent runs commands inside Docker containers for isolation and reproducibility. Without Docker, commands run directly on the host. See Docker Sandbox for details.

The setup wizard installs remaining dependencies (git, ssh, Chromium) automatically.

Pricing

Codality costs $89/year per instance — unlimited projects, users, and agent runs. You bring your own API keys and pay OpenAI directly for token usage. During the beta period, no license key is required.

See Pricing for details.

Next steps

  • Installation — Download the binary and run the setup wizard
  • Server Setup — Reverse proxy, firewall, backups, and production tips
  • Projects — Create your first project