Codify

中文说明

Codify is an AI-assisted service that turns GitLab issue comments into code changes, branches, commits, and Merge Requests. It also ships with a Vue-based dashboard for task operations, scheduling, monitoring, analytics, configuration, and access control.

What it does

• Watches GitLab issue comments such as @ai-bot <prompt>
• Creates tasks with priority, scheduling, retry, and manual execution support
• Runs each task in an isolated Docker worker container
• Uses a Claude CLI-compatible backend to generate and apply changes
• Pushes commits, creates or updates Merge Requests, and posts progress back to GitLab
• Provides a dashboard for tasks, logs, monitoring, analytics, sessions, config, and auth

Request flow

1. GitLab sends a webhook to /api/webhook/gitlab
2. Backend parses the command and stores a Task
3. Scheduler selects runnable tasks by status, priority, schedule, and concurrency
4. Worker executor launches a dedicated Docker container
5. The worker clones the repo, runs Claude CLI, commits, pushes, and updates the MR
6. Dashboard users track status, logs, containers, analytics, and configuration

Key components

• backend/app/api/webhook.py — GitLab webhook receiver
• backend/app/api/tasks.py — task APIs and queue views
• backend/app/core/worker.py — task execution and MR updates
• backend/app/scheduler.py — priority scheduling and crash recovery
• backend/app/api/config.py — runtime and auth configuration
• frontend/src/views/ — dashboard pages
• deploy/ — Dockerfiles, compose deployment, worker entrypoint

Dashboard pages

• Task dashboard
• Task detail and logs
• Manual task creation
• Schedule overview
• Analytics
• Monitor
• Sessions
• Configuration
• Access management
• OIDC diagnostics

Quick start

Prerequisites

• Docker and Docker Compose
• A reachable GitLab instance
• A Claude CLI-compatible model endpoint

1. Prepare config

For the bundled Docker deployment, deploy/docker-compose.yml loads deploy/.env.test for backend and scheduler.

Important values include:

• GITLAB_URL
• GITLAB_BOT_TOKEN
• GITLAB_WEBHOOK_SECRET
• ANTHROPIC_BASE_URL
• ANTHROPIC_API_KEY
• ANTHROPIC_MODEL
• CONFIG_ENCRYPTION_KEY
• SECRET_KEY
• SESSION_SECRET

Notes:

• Runtime overrides are persisted in PostgreSQL system_config
• Secrets entered in the dashboard are stored encrypted at rest
• If the PostgreSQL volume is removed, runtime config, users, sessions, and auth state are lost

2. Start the stack

cd deploy
docker-compose up -d --build

Default ports:

• Frontend: http://localhost:8880
• Backend API: http://localhost:8000

3. Configure GitLab webhook

See docs/GITLAB_WEBHOOK_SETUP.md.

4. Configure dashboard auth (optional but recommended)

See docs/GITLAB_OIDC_SETUP.md.

Recommended rollout:

1. Deploy with OIDC disabled
2. Ensure CONFIG_ENCRYPTION_KEY is set
3. Open the dashboard Configuration page
4. Enter OIDC settings and validate them
5. Enable OIDC after the checks succeed

Common commands

Run make help to see all available commands. Key commands:

# Development
make up                     # Start development environment
make build                  # Build all images
make logs                   # View logs
make ps                     # Show running containers

# Testing
make test-unit              # Run unit tests (with coverage)
make test-all               # Run all tests (unit + E2E)
make test-e2e              # Run all E2E tests (Playwright + GitLab)

# Rebuild specific service
make rebuild-backend        # Rebuild backend image
make rebuild-nginx          # Rebuild frontend image
make rebuild-worker         # Rebuild worker image

Usage

GitLab issue flow

Comment on an issue with:

@ai-bot create a hello world function

Codify will queue a task, run the worker, push changes, create or update an MR, and report progress back to GitLab.

Manual task flow

You can also create tasks directly from the dashboard. Manual tasks skip GitLab issue notifications.

Operational notes

• backend and scheduler share the same image in deploy/docker-compose.yml
• backend runs with AUTO_MIGRATE=false; scheduler runs with AUTO_MIGRATE=true
• Dashboard configuration route: /configuration
• Project/task visibility is filtered by GitLab access rules for authenticated users

Related docs

• docs/README.md
• docs/README.zh-CN.md
• docs/DEPLOYMENT.md
• docs/DEVELOPMENT.md
• docs/GITLAB_WEBHOOK_SETUP.md
• docs/GITLAB_OIDC_SETUP.md
• docs/e2e-debugging.md
• docs/SCREENSHOTS.md
• deploy/offline-bundle/README.md

License

MIT