Vibe Kanban

https://www.vibekanban.com/docs
Admin
Vibe Kanban is an orchestration platform for AI coding agents, enabling developers to plan, review,...
Tokens:35,068
Snippets:681
Trust Score:7.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Run Caddy with Example Configuration

Source: https://www.vibekanban.com/docs/self-hosting/local-development

Starts the Caddy server using the provided example configuration file.

```bash
caddy run --config Caddyfile.example
```

--------------------------------

### Configure Setup Scripts

Source: https://www.vibekanban.com/docs/settings/projects-repositories

Commands executed in the repository root before the coding agent starts. Use these to install dependencies or prepare the environment.

```bash
# Node.js project
npm install

# Python project
pip install -r requirements.txt

# Multiple commands
npm install && npm run build:deps

# Rust project
cargo fetch
```

--------------------------------

### Run OpenCode initialization

Source: https://www.vibekanban.com/docs/agents/opencode

Executes the OpenCode setup process using npx.

```bash
npx -y opencode-ai
```

--------------------------------

### Initialize Qwen Code Assistant

Source: https://www.vibekanban.com/docs/agents/qwen-code

Executes the Qwen code assistant setup process using npx.

```bash
npx -y @qwen-code/qwen-code
```

--------------------------------

### Run Gemini CLI

Source: https://www.vibekanban.com/docs/agents/gemini-cli

Execute the Gemini CLI package using npx to begin the setup process.

```bash
npx -y @google/gemini-cli
```

--------------------------------

### Launch Vibe Kanban

Source: https://www.vibekanban.com/docs/agents/github-copilot

Starts the Vibe Kanban application after successful authentication.

```bash
npx vibe-kanban
```

--------------------------------

### Start Development Services

Source: https://www.vibekanban.com/docs/self-hosting/local-development

Commands to initialize the development stack from either the remote directory or the repository root.

```bash
cd crates/remote
docker compose --env-file .env.remote -f docker-compose.yml up --build
```

```bash
pnpm run remote:dev
```

--------------------------------

### Install Docker on Linux

Source: https://www.vibekanban.com/docs/self-hosting/deploy-docker

Installs Docker on Ubuntu/Debian systems and adds the current user to the docker group.

```bash
# Install Docker (Ubuntu/Debian)
curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER

# Log out and back in for group changes to take effect
```

--------------------------------

### update_setup_script

Source: https://www.vibekanban.com/docs/integrations/vibe-kanban-mcp-server

Updates the setup script for a repository.

```APIDOC
## update_setup_script

### Description
Updates a repository's setup script.

### Parameters
- **repo_id** (string) - Required
- **script** (string) - Required

### Returns
- Update confirmation
```

--------------------------------

### Install Cursor Agent CLI

Source: https://www.vibekanban.com/docs/agents/cursor-cli

Use this command to download and install the Cursor Agent CLI on your system.

```bash
curl https://cursor.com/install -fsS | bash
```

--------------------------------

### Deploy Services with Docker Compose

Source: https://www.vibekanban.com/docs/self-hosting/deploy-docker

Commands to build, start, and monitor the production services.

```bash
cd crates/remote

# Build and start all services
docker compose --env-file ../../.env.remote -f docker-compose.prod.yml up -d --build

# View logs
docker compose -f docker-compose.prod.yml logs -f
```

--------------------------------

### Install Droid CLI

Source: https://www.vibekanban.com/docs/agents/droid

Platform-specific commands to install the Factory AI CLI tool.

```bash
curl -fsSL https://app.factory.ai/cli | sh
```

```powershell
irm https://app.factory.ai/cli/windows | iex
```

--------------------------------

### Complete Workflow Sequence

Source: https://www.vibekanban.com/docs/integrations/vibe-kanban-mcp-server

A multi-step workflow example demonstrating the use of various MCP tools for project management.

```text
1. List organisations to find the organisation ID
2. List projects in the organisation to find the project ID
3. List issues in the project filtered by status
4. Create a new issue for "Add user profile page"
5. Assign a team member to the issue
6. Start a workspace session for the issue using Amp on the develop branch
```

--------------------------------

### Define Development Server Commands

Source: https://www.vibekanban.com/docs/settings/projects-repositories

Common commands for starting development servers across various frameworks. Ensure the server outputs its URL to stdout for preview detection.

```bash
npm run dev
```

```bash
npm start
```

```bash
python manage.py runserver
```

```bash
rails server
```

--------------------------------

### get_repo

Source: https://www.vibekanban.com/docs/integrations/vibe-kanban-mcp-server

Gets details for a specific repository.

```APIDOC
## get_repo

### Description
Retrieves repository details including setup, cleanup, and dev server scripts.

### Parameters
- **repo_id** (string) - Required

### Returns
- Repository info
```

--------------------------------

### Launch CCR Local UI

Source: https://www.vibekanban.com/docs/agents/ccr

Starts the local interface for configuring LLM providers and model mappings.

```bash
npx -y @musistudio/claude-code-router ui
```

--------------------------------

### Configure Docker Compose Ports

Source: https://www.vibekanban.com/docs/self-hosting/local-development

Example configuration for mapping host ports to container ports in docker-compose.yml.

```yaml
ports:
  - "127.0.0.1:3001:8081"  # Change 3001 to your preferred port
```

--------------------------------

### Install Azure DevOps Extension

Source: https://www.vibekanban.com/docs/integrations/azure-repos-integration

Adds repository and pull request management commands to the Azure CLI.

```bash
az extension add --name azure-devops
```

--------------------------------

### Combine Cleanup Commands

Source: https://www.vibekanban.com/docs/settings/projects-repositories

Examples of chaining multiple cleanup commands, including using logical operators to handle failures.

```bash
# Chain commands with &&
docker compose down && rm -rf tmp/

# Format code after agent changes
npx prettier --write . && npx eslint --fix .

# Rust formatting and linting
cargo fmt && cargo clippy --fix --allow-dirty

# Use || true to ignore failures
pkill -f "node server.js" || true
rm -rf .cache/ || true
```

--------------------------------

### Start a Workspace Session via Natural Language

Source: https://www.vibekanban.com/docs/integrations/vibe-kanban-mcp-server

Request a workspace session for a specific issue using a coding agent.

```text
Start working on the user registration issue using Claude Code on the main branch.
```

--------------------------------

### Configure Local Authentication

Source: https://www.vibekanban.com/docs/self-hosting/deploy-docker

Sets environment variables for a single local admin user. Use this for initial setup if OAuth is not yet configured.

```env
SELF_HOST_LOCAL_AUTH_EMAIL=admin@example.com
SELF_HOST_LOCAL_AUTH_PASSWORD=replace_with_a_strong_password
```

--------------------------------

### Initialize GitHub Copilot CLI

Source: https://www.vibekanban.com/docs/agents/github-copilot

Executes the GitHub Copilot CLI tool using npx.

```bash
npx -y @github/copilot
```

--------------------------------

### Configure Desktop Client for Local Server

Source: https://www.vibekanban.com/docs/self-hosting/local-development

Environment variable and command sequence to point the desktop client to the local development instance.

```bash
# In a new terminal, from the repository root
export VK_SHARED_API_BASE=http://localhost:3000

pnpm install
pnpm run dev
```

--------------------------------

### Clone the Vibe Kanban Repository

Source: https://www.vibekanban.com/docs/self-hosting/local-development

Initializes the local development environment by cloning the source code and navigating into the directory.

```bash
git clone https://github.com/BloopAI/vibe-kanban.git
cd vibe-kanban
```

--------------------------------

### Run OpenAI Codex

Source: https://www.vibekanban.com/docs/agents/openai-codex

Initializes the OpenAI Codex tool using npx.

```bash
npx -y @openai/codex
```

--------------------------------

### start_workspace

Source: https://www.vibekanban.com/docs/integrations/vibe-kanban-mcp-server

Creates a new workspace and initiates the first coding-agent session.

```APIDOC
## start_workspace

### Description
Create a workspace and start its first coding-agent session.

### Parameters
- **name** (string) - Required - The name of the workspace.
- **executor** (string) - Required - The coding agent executor (e.g., claude-code, amp, gemini).
- **repositories** (array) - Required - List of objects containing `repo_id` (UUID) and `branch`.
- **prompt** (string) - Optional - Initial prompt for the workspace.
- **variant** (string) - Optional - Workspace variant.
- **issue_id** (string) - Optional - Remote issue ID to link to the workspace.

### Returns
- **Workspace ID** (string)
```

--------------------------------

### Stop Docker Compose Services

Source: https://www.vibekanban.com/docs/self-hosting/local-development

Commands to stop the stack, with an option to remove volumes for a fresh start.

```bash
docker compose down
```

```bash
docker compose down -v
```

--------------------------------

### Plan and Create Issues via Natural Language

Source: https://www.vibekanban.com/docs/integrations/vibe-kanban-mcp-server

Provide a project description followed by a command to trigger the create_issue tool.

```text
I need to build a user authentication system with the following features:
- User registration with email validation
- Login/logout functionality
- Password reset capability
- Session management
- Protected routes

Then turn this plan into issues.
```

--------------------------------

### Run Amp Agent

Source: https://www.vibekanban.com/docs/agents/amp

Initializes the Amp agent using the npx package runner.

```bash
npx -y @sourcegraph/amp
```

--------------------------------

### Initialize Claude Code

Source: https://www.vibekanban.com/docs/agents/claude-code

Executes the Claude Code agent using npx.

```bash
npx -y @anthropic-ai/claude-code
```

--------------------------------

### Authenticate with Azure

Source: https://www.vibekanban.com/docs/integrations/azure-repos-integration

Initiates the browser-based authentication flow for the Azure CLI.

```bash
az login
```

--------------------------------

### list_repos

Source: https://www.vibekanban.com/docs/integrations/vibe-kanban-mcp-server

Lists all available repositories.

```APIDOC
## list_repos

### Description
Retrieves a list of all repositories with their IDs and names.

### Returns
- List of repositories
```

--------------------------------

### Troubleshoot Database Connection

Source: https://www.vibekanban.com/docs/self-hosting/deploy-docker

Inspects database logs and restarts the server if connection issues occur during startup.

```bash
docker compose -f docker-compose.prod.yml logs remote-db
docker compose -f docker-compose.prod.yml restart remote-server
```

--------------------------------

### Configure Environment Variables

Source: https://www.vibekanban.com/docs/self-hosting/deploy-docker

Create this .env.remote file in the repository root to define authentication, database, and service configuration secrets.

```env
# Required secrets
VIBEKANBAN_REMOTE_JWT_SECRET=<your_generated_jwt_secret>
ELECTRIC_ROLE_PASSWORD=<secure_password_for_electric>
DB_PASSWORD=<secure_database_password>

# Your domain
DOMAIN=your-domain.com

# Relay API base URL (required if you enable relay/tunnel)
VITE_RELAY_API_BASE_URL=https://relay.your-domain.com

# Authentication — configure at least one provider, or set bootstrap local auth credentials.
GITHUB_OAUTH_CLIENT_ID=your_github_client_id
GITHUB_OAUTH_CLIENT_SECRET=your_github_client_secret
GOOGLE_OAUTH_CLIENT_ID=
GOOGLE_OAUTH_CLIENT_SECRET=
SELF_HOST_LOCAL_AUTH_EMAIL=
SELF_HOST_LOCAL_AUTH_PASSWORD=

# Email (optional — leave empty to disable invitation emails)
LOOPS_EMAIL_API_KEY=

# Loops transactional email template IDs (optional — defaults are the upstream templates).
# Override these with your own Loops account template IDs if using a custom Loops account.
LOOPS_INVITE_TEMPLATE_ID=cmhvy2wgs3s13z70i1pxakij9
LOOPS_REVIEW_READY_TEMPLATE_ID=cmj47k5ge16990iylued9by17
LOOPS_REVIEW_FAILED_TEMPLATE_ID=cmj49ougk1c8s0iznavijdqpo

# Attachments (optional — only set when you want issue attachments enabled)
AZURE_STORAGE_ACCOUNT_NAME=
AZURE_STORAGE_ACCOUNT_KEY=
AZURE_STORAGE_CONTAINER_NAME=issue-attachments
AZURE_STORAGE_ENDPOINT_URL=
AZURE_STORAGE_PUBLIC_ENDPOINT_URL=
```

--------------------------------

### Run Code Formatting Commands

Source: https://www.vibekanban.com/docs/settings/projects-repositories

Standard commands for formatting and linting code within the cleanup script.

```bash
npx prettier --write .
```

```bash
npx eslint --fix .
```

```bash
cargo fmt
```

```bash
cargo clippy --fix --allow-dirty
```

```bash
black .
```

```bash
ruff check --fix .
```

```bash
go fmt ./...
```

--------------------------------

### Backup Database

Source: https://www.vibekanban.com/docs/self-hosting/deploy-docker

Creates a SQL dump of the remote database container to a local file.

```bash
docker compose -f docker-compose.prod.yml exec remote-db \
  pg_dump -U remote remote > backup_$(date +%Y%m%d).sql
```

--------------------------------

### Locate Database Directories for Reset

Source: https://www.vibekanban.com/docs/troubleshooting

Paths to the application data directories that must be deleted to wipe the database. This action is irreversible.

```bash
~/Library/Application Support/ai.bloop.vibe-kanban/
```

```bash
~/.local/share/vibe-kanban/
```

```bash
%APPDATA%\bloop\vibe-kanban\
```

--------------------------------

### Workspace Configuration JSON

Source: https://www.vibekanban.com/docs/integrations/vibe-kanban-mcp-server

The JSON structure used by the start_workspace tool to initialize a coding environment.

```json
{
  "name": "User registration with email validation",
  "executor": "claude-code",
  "repositories": [
    {
      "repo_id": "987fcdeb-51a2-3d4e-b678-426614174001",
      "branch": "main"
    }
  ],
  "issue_id": "123e4567-e89b-12d3-a456-426614174000"
}
```

--------------------------------

### Manual MCP Server Configuration

Source: https://www.vibekanban.com/docs/integrations/vibe-kanban-mcp-server

Add this JSON block to your coding agent's MCP configuration file to enable the Vibe Kanban server.

```json
{
  "mcpServers": {
    "vibe_kanban": {
      "command": "npx",
      "args": ["-y", "vibe-kanban@latest", "--mcp"]
    }
  }
}
```

--------------------------------

### Authenticate GitHub CLI

Source: https://www.vibekanban.com/docs/integrations/github-integration

Run this command in your terminal to authenticate the GitHub CLI before using Vibe Kanban integration.

```bash
gh auth login
```

--------------------------------

### Check Disk Usage for Workspaces

Source: https://www.vibekanban.com/docs/workspaces/managing-workspaces

Commands to calculate the disk space consumed by worktrees on different operating systems.

```bash
du -sh $TMPDIR/vibe-kanban/worktrees
```

```bash
du -sh /var/tmp/vibe-kanban/worktrees
```

```powershell
Get-ChildItem "$env:TEMP\vibe-kanban\worktrees" -Recurse | Measure-Object -Property Length -Sum
```

--------------------------------

### Configure .env.remote File

Source: https://www.vibekanban.com/docs/self-hosting/local-development

Template for the .env.remote file containing authentication, OAuth, and service integration settings.

```env
# Required - JWT secret for authentication
VIBEKANBAN_REMOTE_JWT_SECRET=<paste_your_generated_secret_here>

# Optional - Password for ElectricSQL database role (electric_sync user)
ELECTRIC_ROLE_PASSWORD=

# OAuth — configure at least one provider. Leave the other empty or remove it.
GITHUB_OAUTH_CLIENT_ID=your_github_client_id
GITHUB_OAUTH_CLIENT_SECRET=your_github_client_secret

# Google OAuth (leave empty if not using Google login)
GOOGLE_OAUTH_CLIENT_ID=
GOOGLE_OAUTH_CLIENT_SECRET=

# Relay (required for relay/tunnel features)
# For plain HTTP local dev:
VITE_RELAY_API_BASE_URL=http://localhost:8082

# Email invitations (optional — leave empty to disable)
LOOPS_EMAIL_API_KEY=

# Loops transactional email template IDs (optional — defaults are the upstream templates).
# Override these with your own Loops account template IDs if using a custom Loops account.
LOOPS_INVITE_TEMPLATE_ID=cmhvy2wgs3s13z70i1pxakij9
LOOPS_REVIEW_READY_TEMPLATE_ID=cmj47k5ge16990iylued9by17
LOOPS_REVIEW_FAILED_TEMPLATE_ID=cmj49ougk1c8s0iznavijdqpo
```

--------------------------------

### Define Production Docker Compose

Source: https://www.vibekanban.com/docs/self-hosting/deploy-docker

Place this docker-compose.prod.yml file in the crates/remote directory to orchestrate the Caddy reverse proxy, PostgreSQL database, ElectricSQL sync service, and the remote server.

```yaml
services:
  caddy:
    image: caddy:2-alpine
    restart: unless-stopped
    ports:
      - "80:80"
      - "443:443"
    environment:
      DOMAIN: ${DOMAIN}
    volumes:
      - ./Caddyfile:/etc/caddy/Caddyfile
      - caddy_data:/data
      - caddy_config:/config
    depends_on:
      - remote-server

  remote-db:
    image: postgres:16-alpine
    command: ["postgres", "-c", "wal_level=logical"]
    restart: unless-stopped
    environment:
      POSTGRES_DB: remote
      POSTGRES_USER: remote
      POSTGRES_PASSWORD: ${DB_PASSWORD:-remote}
    volumes:
      - remote-db-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U remote -d remote"]
      interval: 5s
      timeout: 5s
      retries: 5
      start_period: 5s

  electric:
    image: electricsql/electric:1.4.13
    working_dir: /app
    restart: unless-stopped
    environment:
      DATABASE_URL: postgresql://electric_sync:${ELECTRIC_ROLE_PASSWORD}@remote-db:5432/remote?sslmode=disable
      PG_PROXY_PORT: 65432
      LOGICAL_PUBLISHER_HOST: electric
      AUTH_MODE: insecure
      ELECTRIC_INSECURE: true
      ELECTRIC_MANUAL_TABLE_PUBLISHING: true
      ELECTRIC_USAGE_REPORTING: false
      ELECTRIC_FEATURE_FLAGS: allow_subqueries,tagged_subqueries
    volumes:
      - electric-data:/app/persistent
    depends_on:
      remote-db:
        condition: service_healthy
      remote-server:
        condition: service_healthy

  remote-server:
    build:
      context: ../..
      dockerfile: crates/remote/Dockerfile
      args:
        VITE_RELAY_API_BASE_URL: ${VITE_RELAY_API_BASE_URL:-}
    restart: unless-stopped
    depends_on:
      remote-db:
        condition: service_healthy
    environment:
      RUST_LOG: info,remote=info
      SERVER_DATABASE_URL: postgres://remote:${DB_PASSWORD:-remote}@remote-db:5432/remote
      SERVER_LISTEN_ADDR: 0.0.0.0:8081
      ELECTRIC_URL: http://electric:3000
      SERVER_PUBLIC_BASE_URL: https://${DOMAIN}
      GITHUB_OAUTH_CLIENT_ID: ${GITHUB_OAUTH_CLIENT_ID:-}
      GITHUB_OAUTH_CLIENT_SECRET: ${GITHUB_OAUTH_CLIENT_SECRET:-}
      GOOGLE_OAUTH_CLIENT_ID: ${GOOGLE_OAUTH_CLIENT_ID:-}
      GOOGLE_OAUTH_CLIENT_SECRET: ${GOOGLE_OAUTH_CLIENT_SECRET:-}
      VIBEKANBAN_REMOTE_JWT_SECRET: ${VIBEKANBAN_REMOTE_JWT_SECRET}
      ELECTRIC_ROLE_PASSWORD: ${ELECTRIC_ROLE_PASSWORD}
      LOOPS_EMAIL_API_KEY: ${LOOPS_EMAIL_API_KEY:-}
      LOOPS_INVITE_TEMPLATE_ID: ${LOOPS_INVITE_TEMPLATE_ID:-cmhvy2wgs3s13z70i1pxakij9}
      LOOPS_REVIEW_READY_TEMPLATE_ID: ${LOOPS_REVIEW_READY_TEMPLATE_ID:-cmj47k5ge16990iylued9by17}
      LOOPS_REVIEW_FAILED_TEMPLATE_ID: ${LOOPS_REVIEW_FAILED_TEMPLATE_ID:-cmj49ougk1c8s0iznavijdqpo}
      SELF_HOST_LOCAL_AUTH_EMAIL: ${SELF_HOST_LOCAL_AUTH_EMAIL:-}
      SELF_HOST_LOCAL_AUTH_PASSWORD: ${SELF_HOST_LOCAL_AUTH_PASSWORD:-}
      AZURE_STORAGE_ACCOUNT_NAME:
      AZURE_STORAGE_ACCOUNT_KEY:
      AZURE_STORAGE_CONTAINER_NAME:
      AZURE_STORAGE_ENDPOINT_URL:
      AZURE_STORAGE_PUBLIC_ENDPOINT_URL:
    healthcheck:
      test: ["CMD", "wget", "--spider", "-q", "http://127.0.0.1:8081/v1/health"]
      interval: 5s
      timeout: 5s
      retries: 10
      start_period: 10s

volumes:
  remote-db-data:
  electric-data:
  caddy_data:
  caddy_config:
```

--------------------------------

### Update VibeKanban

Source: https://www.vibekanban.com/docs/self-hosting/deploy-docker

Updates the local repository and rebuilds the services using the production Docker configuration.

```bash
cd vibe-kanban
git pull origin main

cd crates/remote
docker compose --env-file ../../.env.remote -f docker-compose.prod.yml up -d --build
```
Tokens:
Raw