README

A minimal transparent php kanban TUI with vim-like keybindings.

Installation

Install with composer locally or globally and add appropriate paths to your $PATH environment variable:

composer require surgiie/kantui
# or globally
composer global require surgiie/kantui

Use

# specify context or "board" to use. This lets you manage multiple boards.
export KANTUI_CONTEXT="my-context"
kantui

Note: All data will be written to ~/.kantui directory. If you want to use a different directory, you can set the KANTUI_HOME environment variable.

Configuration

A configuration file maybe placed at ~/.kantui/config.json or at ~/.kantui/contexts/<your-current-context>/config.json to customize some aspects of the application.

Below is the current available configuration options:

{
  "timezone": "America/New_York",
  "human_readable_date": true,
  "delete_done": false
}

timezone: The timezone to use for the application. Defaults to the system timezone. One of any listed here.
human_readable_date: Whether to display dates in a human readable format. e.g "2 days ago". Defaults to true.
delete_done: Delete finished todos permanently instead of moving it to the "done" status and keeping it in the data file. Defaults to true.

Run With Docker:

If you don't have or want to install php, you can run use the provided docker script to spin up a container which you can utilize to run the application.

Install Docker Script:

mkdir $HOME/.local/bin # add to $PATH or customize install location.
wget -qO $HOME/.local/bin/kantui https://raw.githubusercontent.com/surgiie/kantui/refs/heads/main/docker && chmod +x $HOME/.local/bin/kantui

# start app. Image and container will be created if not already present
kantui
# if specific package version is desired, set the desired version as env and run script, new image/container will start.
export KANTUI_VERSION="v0.1.0" && kantui

# attach to the container and start a bash shell
kantui --attach

Note - Your ~/.kantui directory will automatically be mounted on initial run and any KANTUI_ env variables will automatically be passed to the container.

Keybindings

Navigation

j or ↓ - Move cursor down
k or ↑ - Move cursor up
h or ← - Move cursor left (switch to TODO column)
l or → - Move cursor right (switch to IN PROGRESS column)

Todo Management

n - Create a new todo
e - Edit the active todo
x - Delete the active todo
ENTER - Progress todo to next stage (TODO → IN PROGRESS → DONE)
BACKSPACE - Move todo back from IN PROGRESS to TODO
[ - Move item up in the list
] - Move item down in the list

Search & Filter

/ - Search todos by tags or description
f - Filter todos by urgency level
c - Clear all active filters

Other

q - Quit the application

surgiie / kantui

Maintainers

Details