Getting Started
Welcome to Vibe Kanban! This guide helps you install the app, set a default project repo, and run your first agents in parallel.
Prerequisites
- Node.js 18+ - Download from nodejs.org
- Git - Used to create isolated worktrees per task
- A coding agent - See supported agents (Claude Code, Cursor, Copilot, Gemini CLI, and more)
Installation
The easiest way to get started is using npx:
$ npx vibe-kanban
This downloads and runs Vibe Kanban. By default it binds to a random open port; the CLI prints the URL. To pin a port, set VIBEKANBAN_PORT=<port> before starting.
First Task
- Start Vibe Kanban with
npx vibe-kanbanand open the printed URL. - Pick or set your Project repo default in Settings so new tasks start in the right repository.
- Create a new task card on the board and select your coding agent.
- Agents run in isolated git worktrees; monitor progress and open native release notes for updates.
Key Concepts
Tasks
Tasks are individual pieces of work that you assign to coding agents. Each task runs in its own isolated git worktree to avoid conflicts.
Learn more about parallel execution and workspaces.
Workspaces
Workspaces are isolated git worktrees where agents work. This prevents conflicts when running multiple agents in parallel.
Learn more about workspaces.
Agents
Vibe Kanban supports many coding agents including Claude Code, Cursor, GitHub Copilot, Gemini CLI, and more.
See the complete list of supported agents.
Next Steps
- Explore supported agents and configure your favorite
- Learn about running agents in parallel
- Check out best practices in the Vibe Guide
- Read the latest release notes
- Join the community on GitHub
Need Help?
If you run into any issues:
- Check the FAQ for common questions
- Browse full documentation
- Review recent releases
- Open an issue on GitHub