illustration generated using perchance.org

basilk

A Terminal User Interface (TUI) to manage your tasks with minimal kanban logic

History

It was a very hot August night, and I was organizing my activities when at a certain point I felt the need for a software that could help me with this, something simple and portable. basilk is created as a summer project to learn Rust and to be able to use the software anywhere.

The name /ˈbæzəlkeɪ/ comes from the basil plant, which is easy to grow and maintain, and "k" stands for kanban.

Another story

illustration generated using perchance.org

The name /ˈbæzsɪlk/ comes from the union of basil and silk as a symbol of elaborateness due to its production process.

About

basilk is structured to create projects and within each project to create tasks with a specific status (Up Next/On Going/Done).

The data structure is saved in .json format and is available in the directory:

Linux
~/.config/basilk

macOS
~/Library/Application Support/basilk

Windows
<USER>\AppData\Roaming\basilk

The choice to use the JSON format is to make easier to export

Installation

Cargo

from crates.io using cargo

cargo install basilk

AUR

from the AUR with using an AUR helper.

paru -S basilk

Homebrew

from a homebrew tap using brew

brew tap GabAlpha/tap
brew install basilk

Build from source

1. Clone the repository

git clone https://github.com/GabAlpha/basilk && cd basilk

2. Build

cargo build --release

Binary will be located at target/release/basilk

Usage

Run

basilk

All available commands are displayed inside

Contributing

Note

This project is now in beta version and is expected to have bugs

As I mentioned above, this is my first project in Rust, so contributions and help are welcome! If you have any suggestions, improvements, or bug fixes, feel free to submit a pull request or open a new issue.

License

Licensed under either of Apache License Version 2.0 or The MIT License at your option.