TUI Trello Kanban Board

日本語 | 中文 | 한국어

A terminal-based Kanban board. Fully keyboard-driven.

Installation

Using bun (recommended)

bun install -g tui-kanban-board
tkb

Download binary directly

Download the file for your platform from GitHub Releases.

Note: This is a private repository. GitHub authentication is required to download. Using the gh CLI is recommended.

Linux (x64)

gh release download --repo OWNER/REPO --pattern "tkb-linux-x64.tar.gz"
tar xzf tkb-linux-x64.tar.gz
chmod +x tkb
./tkb

macOS (Apple Silicon / M1+)

gh release download --repo OWNER/REPO --pattern "tkb-darwin-arm64.tar.gz"
tar xzf tkb-darwin-arm64.tar.gz
chmod +x tkb
# Skip security check (first time only)
xattr -d com.apple.quarantine tkb
./tkb

macOS (Intel)

gh release download --repo OWNER/REPO --pattern "tkb-darwin-x64.tar.gz"
tar xzf tkb-darwin-x64.tar.gz
chmod +x tkb
xattr -d com.apple.quarantine tkb
./tkb

Windows (x64)

gh release download --repo OWNER/REPO --pattern "tkb-windows-x64.zip"
Expand-Archive tkb-windows-x64.zip .
.\tkb.exe

Usage

Run in a directory containing a .tkb file. If none exists, one will be created automatically.

# Open .tkb in current directory (Workspace scope)
tkb

# Open a specific file
tkb path/to/board.tkb

# Open in Global scope (~/.config/tkb/global.tkb)
tkb --global
tkb -g

# Set language
tkb --lang en
tkb --lang zh
tkb --lang ko

Keyboard Shortcuts

Board

| Key | Action | |-----|--------| | ← / → | Move between columns | | ↑ / ↓ / k / j | Move between cards | | Enter | Preview card | | n | Add new card | | e | Edit card | | d | Delete card | | Shift+←/→ | Move card to adjacent column | | q | Quit |

Columns

| Key | Action | |-----|--------| | N (Shift+n) | Add column (to the right of current) | | E (Shift+e) | Edit column name | | D (Shift+d) | Delete column | | Ctrl+←/→ | Reorder columns |

Preview / Edit Mode

| Key | Action | |-----|--------| | Esc | Close / Cancel | | Ctrl+S | Save | | e | Switch from preview to edit |

Card Format (Markdown)

Card content supports Markdown.

# Heading

**bold** / *italic* / ~~strikethrough~~ / `code`

- list item
  - nested item

1. ordered list
2. second item

| Header1 | Header2 |
|---------|---------|
| Cell1   | Cell2   |

File Format (.tkb)

JSON file. Auto-saved on every change.

{
  "scope": "Workspace",
  "columns": [
    {
      "id": "column-xxx",
      "title": "To Do",
      "tasksIds": ["task-yyy"]
    }
  ],
  "tasks": {
    "task-yyy": {
      "id": "task-yyy",
      "description": "Task content",
      "columnId": "column-xxx"
    }
  }
}

Acknowledgements

This project is inspired by the VS Code extension vscode-extension-trello-kanban-board by Mayank Kumar Chaudhari. We are grateful for his wonderful work that sparked the idea of bringing the same experience to the terminal.

Development

bun install
bun dev