getting-started.mdx 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. ---
  2. title: "Getting Started"
  3. description: "Install Cline Kanban and launch your first board"
  4. ---
  5. ## Prerequisites
  6. - **Node.js 18 or higher** — check with `node --version`
  7. - **A git repository** — Kanban must be run from the root of a git repo
  8. ## Installation
  9. Install Cline CLI globally via npm:
  10. ```bash
  11. npm i -g cline
  12. ```
  13. Then launch Kanban:
  14. ```bash
  15. cline
  16. ```
  17. <Tip>
  18. This launches a local web server and opens the Kanban board in your default browser.
  19. </Tip>
  20. ## First Launch
  21. 1. Open your terminal and `cd` to the root of any git repository
  22. 2. Run `cline`
  23. 3. Your browser opens to the Kanban board
  24. ### Onboarding
  25. On your first launch, Kanban walks you through a short setup:
  26. 1. **Pick a project directory** — a directory picker opens so you can select (or confirm) the repository you want to work in
  27. 2. **Choose your agent** — select which coding agent to use for tasks (Cline, Claude Code, or Codex)
  28. After onboarding, you land on the board and can start creating tasks immediately. No account creation, API keys, or configuration files required.
  29. ## Creating Your First Task
  30. Once the board is open:
  31. 1. **Create a card** — click the add button to create a new task card
  32. 2. **Write a task description** — describe what you want the agent to do
  33. 3. **Hit play** — Kanban creates an ephemeral git worktree for the task and starts an agent in its own terminal
  34. The card updates in real time, showing the agent's latest message or tool call so you can monitor progress from the board.
  35. <Tip>
  36. 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.
  37. </Tip>
  38. ## Next Steps
  39. <Columns cols={2}>
  40. <Card title="Core Workflow" icon="arrows-spin" href="/kanban/core-workflow">
  41. Learn the full workflow: create → link → start → review → ship.
  42. </Card>
  43. <Card title="Features" icon="list-check" href="/kanban/features">
  44. Explore worktrees, auto-commit, task linking, the diff viewer, and more.
  45. </Card>
  46. </Columns>