Get Started

Vibe Kanban keeps you organised while running multiple coding agents in parallel by streamlining how you plan and review their work.

1. Launch Vibe Kanban

Start the Vibe Kanban client and open the UI in your browser:

npx vibe-kanban

2. Confirm your preferences

The first time you run Vibe Kanban, you'll be asked to set your preferred:

• Coding agent
• IDE
• Notification preferences

3. Sign-in to Vibe Kanban

You can use a GitHub or Google account.

4. Navigate the kanban board

After you sign in, we automatically create a personal organisation and an initial project for you, and take you straight there.

Navigating the kanban board:

1. The app bar, used for navigating between projects, the workspaces page (we'll come onto this later) and user settings
2. Issues appear as cards on the kanban board
3. The 'new issue' button, for creating issues
4. The right hand panel where details for the currently selected or draft issue is shown

5. Create an issue

Issues are a core concept of Vibe Kanban, they represent a bug, feature or piece of work to be done. At a minimum, issues consist of a title and description, but you can also add priorities, tags and even connect issues together with parent/child relationships.

When you've filled out the details press 'create issue'.

6. Create a workspace

Workspaces are another core concept of Vibe Kanban, they represent a space to work on an issue with a coding agent. When you create a workspace, Vibe Kanban automatically creates git worktrees for your selected repositories, and launches your coding agent.

To create a workspace, make sure the issue you created is selected and click the 'create' button in the workspaces window.

When you create a workspace, you'll need to specify repositories you'd like to work on, as well as the branches of those repositories to base the git worktrees on.

You'll also need to specify your desired coding agent configuration (e.g. model, effort level, plan mode).

Upon creation, the coding agent will immediately begin executing with the given prompt.

Workspaces don't have to be connected to an issue, which is useful for quick actions like asking questions about a codebase. </Info>

7. Reviewing a workspace

So far we've been viewing the workspace side-by-side with our kanban board. However, if we want more room to review the code changes or test them in a browser, we can open the workspace in the workspaces view.

To access the workspaces view, click the Open Workspace button.

Depending on what you'd like to do, you can view code changes or preview changes to websites in a browser using the floating navigation buttons (3).

You can also navigate back to either your project (1) or the parent issue (2).

8. Merging a workspace

When you're ready to merge the changes in a workspace, you can either open a GitHub pull request or merge the workspace branch locally.

Next steps