Back to Cline

Getting Started

docs/kanban/getting-started.mdx

3.82.01.9 KB
Original Source

Prerequisites

  • Node.js 18 or higher — check with node --version
  • A git repository — Kanban must be run from the root of a git repo

Installation

Install Cline CLI globally via npm:

bash
npm i -g cline

Then launch Kanban:

bash
cline
<Tip> This launches a local web server and opens the Kanban board in your default browser. </Tip>

First Launch

  1. Open your terminal and cd to the root of any git repository
  2. Run cline
  3. Your browser opens to the Kanban board

Onboarding

On your first launch, Kanban walks you through a short setup:

  1. Pick a project directory — a directory picker opens so you can select (or confirm) the repository you want to work in
  2. Choose your agent — select which coding agent to use for tasks (Cline, Claude Code, or Codex)

After onboarding, you land on the board and can start creating tasks immediately. No account creation, API keys, or configuration files required.

Creating Your First Task

Once the board is open:

  1. Create a card — click the add button to create a new task card
  2. Write a task description — describe what you want the agent to do
  3. Hit play — Kanban creates an ephemeral git worktree for the task and starts an agent in its own terminal

The card updates in real time, showing the agent's latest message or tool call so you can monitor progress from the board.

<Tip> You can also use the **sidebar chat** to create tasks. Open the chat and ask the agent to break down work into multiple task cards — it can create, link, and start tasks directly on the board. </Tip>

Next Steps

<Columns cols={2}> <Card title="Core Workflow" icon="arrows-spin" href="/kanban/core-workflow"> Learn the full workflow: create → link → start → review → ship. </Card> <Card title="Features" icon="list-check" href="/kanban/features"> Explore worktrees, auto-commit, task linking, the diff viewer, and more. </Card> </Columns>