https://github.com/janTatesa/kraban

A rust kanban board tui
https://github.com/janTatesa/kraban

Last synced: 9 months ago
JSON representation

A rust kanban board tui

• Host: GitHub
• URL: https://github.com/janTatesa/kraban
• Owner: janTatesa
• License: mit
• Created: 2025-03-29T07:50:07.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2025-06-19T18:47:54.000Z (9 months ago)
• Last Synced: 2025-06-23T15:52:58.425Z (9 months ago)
• Language: Rust
• Size: 177 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ratatui - kraban - Rust kanban board tui inspired by basilk. (💻 Apps / 🚀 Productivity and Utilities)

README

          
# kraban

This project is heavily inspired by 

## Development

It is recommended to use the `flake.nix`. Otherwise you have to manually set `KRABAN_TESTING=true`. This sets the path to the statefile `testing-state.json` and config `testing-config.toml`. The reason is that if you have kraban installed on your system, the development version would conflict. Note that the codebase is ugly and begs for a refactor

## Instalation

The project provides a `flake.nix` for NixOS users. It is also available on crates.io (`cargo install kraban`)

## Features

- [ ] Git sync

- [ ] Task due dates

- [ ] Stats

- [ ] Plugin system

## Configuration

Run `kraban -w` to write the default config to your config dir. All non-obvious options are explained in the comments. Colors can either be specified with number, name or hex

## Importing from basilk

To import from basilk, copy the basilks state file into `STATE_DIRECTORY/kraban/tasks.json`. In linux, the state directory is `.local/state`

## Rename columns

There is currently no way to rename columns, do search and replace in the state file

## Keybindings

Most keybindings are shown in the app. These keybindings are used when entering text

| Mappings                                     | Description                               |

|----------------------------------------------|-------------------------------------------|

| `Ctrl+H`, `Backspace`                        | Delete one character before cursor        |

| `Ctrl+D`, `Delete`                           | Delete one character next to cursor       |

| `Ctrl+K`                                     | Delete from cursor until the end of line  |

| `Ctrl+J`                                     | Delete from cursor until the head of line |

| `Ctrl+W`, `Alt+H`, `Alt+Backspace`           | Delete one word before cursor             |

| `Alt+D`, `Alt+Delete`                        | Delete one word next to cursor            |

| `Ctrl+U`                                     | Undo                                      |

| `Ctrl+R`                                     | Redo                                      |

| `Ctrl+Y`                                     | Paste yanked text                         |

| `Ctrl+F`, `→`                                | Move cursor forward by one character      |

| `Ctrl+B`, `←`                                | Move cursor backward by one character     |

| `Ctrl+P`, `↑`                                | Move cursor up by one line                |

| `Ctrl+N`, `↓`                                | Move cursor down by one line              |

| `Alt+F`, `Ctrl+→`                            | Move cursor forward by word               |

| `Atl+B`, `Ctrl+←`                            | Move cursor backward by word              |

| `Ctrl+E`, `End`, `Ctrl+Alt+F`, `Ctrl+Alt+→`  | Move cursor to the end of line            |

| `Ctrl+A`, `Home`, `Ctrl+Alt+B`, `Ctrl+Alt+←` | Move cursor to the head of line           |

## License

Copyright (c) Tatesa Uradnik 

This project is licensed under the MIT license ([LICENSE] or )

[LICENSE]: ./LICENSE