Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GabAlpha/basilk
🪴 A Terminal User Interface (TUI) to manage your tasks with minimal kanban logic
https://github.com/GabAlpha/basilk
kanban ratatui tasks terminal tui
Last synced: 7 days ago
JSON representation
🪴 A Terminal User Interface (TUI) to manage your tasks with minimal kanban logic
- Host: GitHub
- URL: https://github.com/GabAlpha/basilk
- Owner: GabAlpha
- License: apache-2.0
- Created: 2024-08-04T20:35:16.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-08-21T14:46:28.000Z (4 months ago)
- Last Synced: 2024-08-21T16:42:21.403Z (4 months ago)
- Topics: kanban, ratatui, tasks, terminal, tui
- Language: Rust
- Homepage: https://crates.io/crates/basilk
- Size: 1010 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-ratatui - basilk - A TUI to manage your tasks with minimal kanban logic. (💻 Apps / 🚀 Productivity and Utilities)
README
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](https://www.meteo.it/notizie/meteo-caldo-in-aumento-la-tendenza-verso-ferragosto-c95aa7dc), 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ɪ/_](https://gabalpha.github.io/read-audio/?p=https://github.com/GabAlpha/basilk/raw/master/assets/basil-k.wav) 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/_](https://gabalpha.github.io/read-audio/?p=https://github.com/GabAlpha/basilk/raw/master/assets/bas-silk.wav) 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
\AppData\Roaming\basilk
```
The choice to use the JSON format is to make easier to export
## Installation
### Cargo
from [crates.io](https://crates.io/crates/basilk) using [`cargo`](https://doc.rust-lang.org/cargo/)
```sh
cargo install basilk
```
### AUR
from the [AUR](https://aur.archlinux.org/packages/basilk) with using an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers).
```sh
paru -S basilk
```
### Homebrew
from a [homebrew tap](https://docs.brew.sh/Taps) using [`brew`](https://brew.sh/)
```sh
brew tap GabAlpha/tap
brew install basilk
```
### Build from source
1. Clone the repository
```sh
git clone https://github.com/GabAlpha/basilk && cd basilk
```
2. Build
```sh
cargo build --release
```
Binary will be located at `target/release/basilk`
## Usage
Run
```sh
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
[](./LICENSE-MIT)
[](./LICENSE-APACHE)
Licensed under either of [Apache License Version 2.0](./LICENSE-APACHE) or [The MIT License](./LICENSE-MIT) at your option.