Vibe Kanban
Orchestration platform for AI coding agents. Plan, review, and manage AI-generated code in isolated git worktrees.
Quick Navigation
| Topic | Reference | | ----------------------------- | ------------------------------------------------------- | | Installation & Setup | getting-started.md | | Workspaces (Beta) | workspaces.md | | Projects, Tasks, Review | core-features.md | | Subtasks, Attempts, Conflicts | advanced-features.md | | Settings, Agents, Tags | configuration.md | | GitHub, Azure, VSCode, MCP | integrations.md | | Common Issues | troubleshooting.md | | Best Practices | vibe-guide.md |
Quick Start
Install & Run
npx vibe-kanban
Release Highlights (0.1.15 → 0.1.18)
- MCP server expanded: richer issue retrieval (
get_issueincludes tags/relationships/sub-issues) and new workspace/relationship/tag tools (e.g.update_workspace, relationship + tag mutations). - Frontend routing migrated to TanStack Router (navigation/URLs may differ from older screenshots).
- Reliability improvements around Electric fallback and cancellation/tab-switch handling.
- Review/diff UI improvements (annotation width fixes for horizontal scrolling).
Opens browser automatically. Use PORT=8080 npx vibe-kanban for fixed port.
Prerequisites
- Node.js LTS
- Authenticated coding agent (Claude Code, Codex, Gemini, etc.)
- GitHub CLI (
gh) for PR integration
First Steps
- Authenticate with a coding agent externally
- Run
npx vibe-kanban - Complete setup dialogs
- Create project from existing git repo
- Add tasks and start executing
Two UI Modes
Classic Kanban (Tasks)
Traditional board with columns: To do → In Progress → In Review → Done
Updates in v0.1.7:
- Per-project Kanban views and a refreshed filter dialog
- Sub-issues and Workspaces visibility toggles moved to the filter bar
Workspaces (Beta) — NEW
Modern interface with:
- Sessions: Multiple conversation threads per workspace
- Command Bar:
Cmd/Ctrl + Kfor all actions - Workspace Notes: Document requirements and decisions
- Multi-repo support: Work across multiple repositories
- Integrated Terminal: PTY-backed terminal with shell support
- Session Dropdown: Agent icons displayed next to session titles
- Sidebar filters: Filter by project and PR status (including “No project”)
- Needs Attention: Includes workspaces with unseen activity
Switch between modes via Command Bar → "Open in Old UI"
Core Concepts
Git Worktrees
Each task/workspace runs in an isolated git worktree:
- Agents can't interfere with each other
- Safe from main branch changes
- Automatic cleanup after completion
Task Flow (Classic)
To do → In Progress → In Review → Done
- To do: Task created
- In Progress: Agent executing
- In Review: Agent finished, awaiting review
- Done: Merged or PR merged
Task Attempts
One task can have multiple attempts:
- Different agent
- Different branch
- Fresh conversation context
Supported Agents
| Agent | Variants | | -------------- | --------------------- | | Claude Code | DEFAULT, PLAN, ROUTER | | Codex | DEFAULT, HIGH | | Gemini | DEFAULT, FLASH | | GitHub Copilot | DEFAULT | | Amp | DEFAULT | | Cursor Agent | DEFAULT | | OpenCode | DEFAULT | | Qwen Code | DEFAULT | | Droid | DEFAULT | | Antigravity | DEFAULT |
Select agent when creating task attempt or workspace session.
Project Configuration
Setup Scripts
Run before agent execution (e.g., npm install, cargo build).
Dev Server Scripts
Start dev server for preview (e.g., npm run dev).
Cleanup Scripts
Run after agent finishes (e.g., npm run format).
Copy Files
Files to copy from main project to worktree (e.g., .env).
Task Creation
Press C or click + to create task
Options:
- Create Task: Add to board only
- Create & Start: Add and immediately execute with default agent
Task Tags
Reusable snippets via @mention:
- Type
@in description - Select tag from dropdown
- Content inserted at cursor
Task description editor supports markdown paste and preserves inline code formatting.
Code Review
- Task moves to "In Review" when agent finishes
- Click Diff icon to view changes
- Click
+on any line to add comment - Submit all comments together
- Task returns to "In Progress" for fixes
Git Operations
| Action | Description | | --------- | --------------------------------- | | Merge | Merge to target branch | | Create PR | Open PR on GitHub/Azure | | Rebase | Update with target branch changes | | Push | Push additional changes to PR |
Preview Mode
Test web apps without leaving Vibe Kanban:
- Configure dev server script in project settings
- Click "Start Dev Server" in Preview tab
- View app in embedded iframe
- Install
vibe-kanban-web-companionfor component selection
Keyboard Shortcuts
| Key | Action |
| ---------------- | ----------------------------------- |
| C | Create task |
| ⌘/Ctrl + Enter | Submit/Send message |
| k/j | Navigate up/down in column |
| h/l | Navigate left/right between columns |
| Enter | Open task |
| ⌘/Ctrl + S | Focus search |
MCP Integration
Add MCP Servers to Agents
Settings → MCP Servers → Select agent → Add servers
Vibe Kanban MCP Server
Expose Vibe Kanban to external MCP clients:
{
"mcpServers": {
"vibe_kanban": {
"command": "npx",
"args": ["-y", "vibe-kanban@latest", "--mcp"]
}
}
}
MCP tools include: list_workspaces, update_workspace, list_projects, list_issues, get_issue, update_issue, plus tag and relationship helpers.
Critical Safety Note
Vibe Kanban runs agents with --dangerously-skip-permissions/--yolo by default for autonomous operation. Each task runs in isolated worktree, but agents can still perform system-level actions. Review work and keep backups.
Critical Prohibitions
- Do not skip agent authentication before first use
- Do not ignore worktree isolation benefits
- Do not forget to configure setup/cleanup scripts for dependencies
- Do not mix multiple agents on same task without new attempts
- Do not ignore rebase conflicts — resolve or abort