https://github.com/zaloog/kanban-tui
Task Manager with a TUI written in Python
https://github.com/zaloog/kanban-tui
kanban python task-manager textual tui uv
Last synced: 3 months ago
JSON representation
Task Manager with a TUI written in Python
- Host: GitHub
- URL: https://github.com/zaloog/kanban-tui
- Owner: Zaloog
- License: mit
- Created: 2024-08-20T08:14:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-10T16:29:58.000Z (5 months ago)
- Last Synced: 2026-01-11T04:29:04.536Z (5 months ago)
- Topics: kanban, python, task-manager, textual, tui, uv
- Language: Python
- Homepage:
- Size: 7.89 MB
- Stars: 141
- Watchers: 2
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://github.com/astral-sh/ruff)
[](https://pypi.org/project/kanban-tui/)
[](https://pypi.python.org/pypi/kanban-tui)
[](https://opensource.org/licenses/MIT)
[](https://pepy.tech/project/kanban-tui)
[](https://coveralls.io/github/Zaloog/kanban-tui?branch=main)
# kanban-tui
A customizable terminal-based task manager powered by [Textual][textual] with multiple backends.
Now also usable in co-op mode with AI agents (check the [CLI interface](#cli-interface) and [MCP Server](#mcp-server) section for more info).
## Demo
Try `kanban-tui` instantly without installation:
```bash
uvx kanban-tui demo
```
## Features
following the xdg basedir convention
kanban-tui utilizes [pydantic-settings] and [xdg-base-dirs] `user_config_dir` to save
the config file and `user_data_dir` for the sqlite database.
you can get an overview of all file locations with `uvx kanban-tui info`
Customizable Board
kanban-tui comes with four default columns
(`Ready`, `Doing`, `Done`, `Archive`) but can be customized to your needs.
More columns can be created via the `Settings`-Tab. Also the visibility and order of columns can be adjusted.
Deletion of existing columns is only possible, if no task is present in the column you want to delete.
Multiple Backends
kanban-tui currently supports three backends.
- **sqlite** (default) | Supports all features of `kanban-tui`
- **jira** | Connect to your jira instance via api key and query tasks via jql.
Columns are defined by task transitions.
- **claude** | Read the `.json` files under `~/.claude/tasks/`. Boards are created for each session ID.
Supports only a subset of features
Multi Board Support
With version v0.4.0 kanban-tui allows the creation of multiple boards.
Use `B` on the `Kanban Board`-Tab to get an overview over all Boards including
the amount of columns, tasks and the earliest Due Date.
Task Management
When on the `Kanban Board`-Tab you can `create (n)`, `edit (e)`, `delete (d)` or `move (H, L)` tasks between columns.
Movement between columns is also supported via mouse drag and drop.
Task dependencies can be defined, which restrict movement to the `Doing` (start_column).
To have the restrictions available, the status columns must be defined on the settings screen.
Task Dependencies
Tasks can have dependencies on other tasks, creating a workflow where certain tasks must be completed before others can proceed.
- **Add Dependencies**: When editing a task, use the dependency selector dropdown to add other tasks as dependencies
- **Remove Dependencies**: Select a dependency in the table and press enter to remove it
- **Blocking Prevention**: Tasks with unfinished dependencies cannot be moved to start/finish columns
- **Circular Detection**: The system prevents circular dependencies (Task A depends on Task B, Task B depends on Task A)
- **Visual Indicators**: Task cards show visual cues for dependency status:
- 🔒 "Blocked by X unfinished tasks" - Task has dependencies that aren't finished yet
- ❗ "Blocking Y tasks" - Other tasks depend on this one
- ✅ "No dependencies" - Task has no dependency relationships
- **CLI Support**: Dependencies can be managed via the CLI with the `--depends-on` flag when creating tasks, or using the `--force` flag to override blocking when moving tasks
Database Information
The current database schema looks as follows.
The Audit table is filled automatically based on triggers.
```mermaid
erDiagram
tasks }|--o| categories: have
tasks }|--|| audits: updates
tasks ||--o{ task_dependencies: "blocks"
tasks ||--o{ task_dependencies: "blocked_by"
tasks {
INTEGER task_id PK
INTEGER column FK
INTEGER category FK
TEXT title
TEXT description
DATETIME creation_date
DATETIME start_date
DATETIME finish_date
DATETIME due_date
TEXT metadata
}
task_dependencies {
INTEGER dependency_id PK
INTEGER task_id FK
INTEGER depends_on_task_id FK
}
boards }|--o{ columns: contains
boards }|--|| audits: updates
boards {
INTEGER board_id PK
INTEGER reset_column FK
INTEGER start_column FK
INTEGER finish_column FK
TEXT name
TEXT icon
DATETIME creation_date
}
columns ||--|{ tasks: contains
columns }|--|| audits: updates
columns {
INTEGER column_id PK
INTEGER board_id FK
TEXT name
BOOLEAN visible
INTEGER position
}
categories {
INTEGER category_id PK
TEXT name
TEXT color
}
audits {
INTEGER event_id PK
DATETIME event_timestamp
TEXT event_type
TEXT object_type
INTEGER object_id
TEXT object_field
TEXT value_old
TEXT value_new
}
```
Visual Summary and Audit Table
To give you an overview over the amount of tasks you `created`, `started` or `finished`, kanban-tui
provides an `Overview`-Tab to show you a bar-chart on a `monthly`, `weekly` or `daily` scale.
It also can be changed to a stacked bar chart per category.
This feature is powered by the [plotext] library with help of [textual-plotext].
There is also an audit table, which tracks the creation/update/deletion of tasks/boards and columns.
## Installation
You can install `kanban-tui` with one of the following options:
```bash
uv tool install kanban-tui
```
```bash
pipx install kanban-tui
```
```bash
# not recommended
pip install kanban-tui
```
I recommend using [pipx] or [uv] to install CLI Tools into an isolated environment.
To be able to use `kanban-tui` in your browser with the `--web`-flag, the optional dependency
`textual-serve` is needed. You can add this to `kanban-tui` by installing the optional `web`-dependency
with the installer of your choice, for example with [uv]:
```bash
uv tool install 'kanban-tui[web]'
```
## Usage
kanban-tui now also supports the `kanban-tui` entrypoint besides `ktui`.
This was added to support easier installation via [uv]'s `uvx` command.
### Normal Mode
Start `kanban-tui` with by just running the tool without any command. The application can be closed by pressing `ctrl+q`.
Pass the `--web` flag and follow the shown link to open `kanban-tui` in your browser.
```bash
ktui
```
### Demo Mode
Creates a temporary Config and Database which is populated with example Tasks to play around.
Kanban-Tui will delete the temporary Config and Database after closing the application.
Pass the `--clean` flag to start with an empty demo app.
Pass the `--keep` flag to tell `kanban-tui` not to delete the temporary Database and Config.
Pass the `--web` flag and follow the shown link to open `kanban-tui` in your browser.
```bash
ktui demo
```
### Clear Database and Configuration
If you want to start with a fresh database and configuration file, you can use this command to
delete your current database and configuration file.
```bash
ktui clear
```
### Create or Update Agent SKILL.md File
With version v0.11.0 kanban-tui offers a [CLI Interface](#cli-interface-to-manage-tasks) to manage tasks, boards and columns.
This is targeted mainly for agentic use e.g. via [Claude][claude-code], because references will be made only by ids, but some commands
are also ergonomic for human use (e.g. task or board creation).
```bash
ktui skill init/update/delete
```
### CLI Interface to manage Tasks
The commands to manage tasks, boards and columns via the CLI are all build up similarly. For detailed overview of arguments
and options please use the `--help` command.
Note that not every functionality is supported yet (e.g. category management, column customisation).
```bash
ktui task list/create/update/move/delete
ktui board list/create/delete/activate
ktui column list
```
### MCP Server
In addition to skills, `kanban-tui` can be run as a local mcp server, which exposes the `ktui task/board/column` commands.
This requires the optional `mcp` dependency, which can be installed via `uv tool install kanban-tui[mcp]`. It utilizes [pycli-mcp]
to directly expose the commands.
Using the bare `ktui mcp` command shows the instruction to add `kanban-tui` mcp to [claude-code]. The server itself is
started using the `--start-server` flag.
```bash
ktui mcp
```
### Show Location of Data, Config and Skill Files
`kanban-tui` follows the [XDG] basedir-spec and uses the [xdg-base-dirs] package to get the locations for data and config files.
You can use this command to check where the files are located, that `kanban-tui` creates on your system.
```bash
ktui info
```
## Feedback and Issues
Feel free to reach out and share your feedback, or open an [Issue],
if something doesn't work as expected.
Also check the [Changelog] for new updates.
[Changelog]: https://github.com/Zaloog/kanban-tui/blob/main/CHANGELOG.md
[Issue]: https://github.com/Zaloog/kanban-tui/issues
[textual]: https://textual.textualize.io
[pipx]: https://github.com/pypa/pipx
[PyPi]: https://pypi.org/project/kanban-tui/
[plotext]: https://github.com/piccolomo/plotext
[textual-plotext]: https://github.com/Textualize/textual-plotext
[xdg-base-dirs]: https://github.com/srstevenson/xdg-base-dirs
[pydantic-settings]: https://pypi.org/project/pydantic-settings/
[pycli-mcp]: https://github.com/ofek/pycli-mcp
[XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
[uv]: https://docs.astral.sh/uv
[claude-code]: https://code.claude.com/docs/en/overview