Getting Started

Welcome to Vibe Kanban! This guide will help you get up and running in just a few minutes.

Prerequisites

• Node.js 18+ - Download from nodejs.org
• Git - Required for workspace management
• A coding agent - See supported agents

Installation

The easiest way to get started is using npx:

$ npx vibe-kanban

This will download and run Vibe Kanban. For a permanent installation, see our installation guide.

First Task

1. Start Vibe Kanban by running npx vibe-kanban
2. Open the web interface (usually at http://localhost:3000)
3. Create a new task or workspace
4. Select your coding agent
5. Watch as your agent works in the background!

Key Concepts

Tasks

Tasks are individual pieces of work that you assign to coding agents. Each task runs in its own isolated workspace.

Learn more about creating and managing tasks.

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, OpenAI Codex, GitHub Copilot, and more.

See the complete list of supported agents.

Next Steps

• Read the Quick Start guide for a hands-on tutorial
• Explore supported agents and configure your favorite
• Learn about running agents in parallel
• Check out best practices in the Vibe Guide
• Join the community on GitHub

Need Help?

If you run into any issues:

• Check the FAQ for common questions
• Read the Troubleshooting guide
• Browse full documentation
• Open an issue on GitHub