surgiie/kantui

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

v0.1.0 2025-02-27 03:08 UTC

Requires

• php: ^8.3
• amphp/amp: ^3.1
• illuminate/pagination: ^11.42
• illuminate/support: ^11.42
• laravel/prompts: ^0.3.4
• php-tui/php-tui: ^0.2.1
• ramsey/uuid: ^4.7

Requires (Dev)

• fakerphp/faker: ^1.24
• laravel/pint: ^1.20
• symfony/var-dumper: ^7.2

MIT

• php
• todo
• kanban
• tui

README

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

Inspired By: skan(now archived).

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:

# Assumes $PATH includes $HOME/.local/bin, add or customize as needed
desired_version=0.1.0 && wget -qO $HOME/.local/bin/kantui https://raw.githubusercontent.com/surgiie/kantui/refs/tags/v$desired_version/docker && chmod +x $HOME/.local/bin/kantui

# start app. Image and container will be created if not already present
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.