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.

​
Installation

Kanban CLI can be installed using multiple methods depending on your system and preferences. Choose the installation method that works best for you.

​
System Requirements

Minimum Requirements:
  • Rust 1.70+ (for cargo installation)
  • Linux, macOS, or Windows
  • Terminal with Unicode support
  • At least 10MB of disk space

​
Installation Methods

1

Choose Your Installation Method

Select one of the following installation methods based on your environment:
# Install from Rust package registry
cargo install kanban-cli
Recommended: Use cargo install kanban-cli for the simplest installation experience if you already have Rust installed.
2

Verify Installation

After installation, verify that Kanban is correctly installed by checking the version:
kanban --version
You should see output similar to:
kanban 0.2.0
commit: abc123def
The exact version number and commit hash will vary depending on when you installed Kanban.
3

Test the Installation

Launch Kanban to ensure everything is working:
kanban
You should see the TUI interface launch. Press ? to view the help menu, or press q to quit.

​
Linux Clipboard Support

Linux Users: For clipboard operations (y/Y to copy branch names) to persist after exiting, you need a clipboard manager running.
Kanban supports copying card information to your system clipboard, but on Linux, copied content is lost when the app exits unless you have a clipboard manager installed. This is a Linux platform limitation, not a bug.

​
Required Clipboard Managers

Install one of the following clipboard managers for Wayland:
# wl-clip-persist (recommended)
sudo apt install wl-clip-persist  # Debian/Ubuntu
sudo pacman -S wl-clip-persist    # Arch Linux

# Or use alternatives:
# - cliphist
# - clipman
# - Your desktop environment's built-in manager

​
Shell Completions (Optional)

Generate shell completions for better command-line experience: 
# Add to your ~/.bashrc
kanban completions bash > ~/.local/share/bash-completion/completions/kanban

​
Environment Variables

You can configure Kanban using environment variables:
VariableDescriptionExample
KANBAN_FILEDefault data file pathexport KANBAN_FILE=~/projects/myboard.json
KANBAN_DEBUG_LOGDebug log file pathexport KANBAN_DEBUG_LOG=~/kanban-debug.log
EDITORPreferred text editorexport EDITOR=vim
Add export KANBAN_FILE=~/kanban.json to your shell profile (.bashrc, .zshrc, etc.) to set a default board location.

​
Updating Kanban

To update to the latest version: 
# Update from crates.io
cargo install kanban-cli --force

​
Troubleshooting

Ensure that cargo’s bin directory is in your PATH:
echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
Install a clipboard manager for your display server (see Linux Clipboard Support section above).
Update your Rust toolchain:
rustup update stable
Ensure your terminal supports Unicode and has a font with icon support installed (e.g., Nerd Fonts).

​
Next Steps

Now that you have Kanban installed, learn how to use it:

Quick Start Guide

Learn the basics of creating boards, adding cards, and navigating the interface

Build docs developers (and LLMs) love

Get started for freeTalk to us