Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/fulsomenko/kanban/llms.txt

Use this file to discover all available pages before exploring further.

Terminal-Based Project Management

Fast, Keyboard-Driven
Kanban Boards

Manage your projects with vim-like efficiency. Sprint planning, card dependencies, and real-time collaboration — all from your terminal.

Get StartedInstallation

Quick Start

Get up and running with Kanban in minutes

1

Install Kanban

Install using your preferred method:
cargo install kanban-cli
2

Launch the TUI

Start the interactive terminal interface:
kanban
Or load a specific board file:
kanban myboard.json
3

Create your first board

Press n to create a new board, then press Enter to activate it. Add cards with n and organize them across columns using vim-like navigation (hjkl).
Press ? at any time to view all available keyboard shortcuts for your current context.

Key Features

Everything you need for agile project management in the terminal

Vim-Like Navigation

Blazing fast navigation with hjkl movement, / search, and context-aware shortcuts. Built for keyboard warriors.

Sprint Planning

Plan and track sprints with story points, card assignments, and automatic progress tracking.

Card Dependencies

Create parent-child and blocking relationships between cards to model complex workflows.

Multiple Views

Switch between flat list, grouped by column, or classic kanban board layout with a single keystroke.

Undo/Redo

Press u to undo and U to redo any action. Your entire action history is preserved.

CLI Interface

Complete command-line interface for scripting, automation, and CI/CD integration.

MCP Server

Integrate with LLM tools like Claude and Cursor using the Model Context Protocol server.

Multi-Instance Support

Real-time file watching with conflict detection and automatic reload for concurrent editing.

Explore by Topic

Dive deeper into specific areas of Kanban

Terminal UI Guide

Master the interactive terminal interface with vim-like shortcuts and efficient workflows.

Learn more

CLI Reference

Complete command-line reference for boards, cards, columns, sprints, and automation.

View commands

Core Concepts

Understand boards, columns, cards, sprints, dependencies, and the undo/redo system.

Explore concepts

Architecture & Contributing

Learn about the Rust workspace structure, SOLID principles, and how to contribute.

Start contributing

Ready to get started?

Install Kanban and start managing your projects with terminal efficiency.

View Quickstart