To-Do TUI

A beautiful terminal-based todo list application built with Rust and ratatui.

Features

• ✨ Clean, modern terminal UI
• 📝 Add, delete, and toggle todo items
• 💾 Automatic persistence to disk
• ⌨️ Vim-like keyboard navigation
• 🎨 Colorful, intuitive interface

Installation

Prerequisites

• Rust (latest stable version recommended)
• A terminal that supports colors and Unicode

Build from Source

git clone <repository-url>
cd to-do-tui
cargo build --release

The binary will be in target/release/to-do-tui.

Usage

Running the Application

cargo run
# or if installed:
to-do-tui

Keyboard Shortcuts

Navigation Mode (default)

• j or ↓ - Move down
• k or ↑ - Move up
• a or A - Add new todo item
• d or D - Delete selected item
• Space or Enter - Toggle completion status
• q or Esc - Quit

Input Mode

• Enter - Submit new todo item
• Esc - Cancel and return to navigation

Data Storage

Todo items are automatically saved to:

• Linux: ~/.local/share/to-do-tui/todos.json
• macOs: ~/Library/Application Support
• Windows: %APPDATA%\to-do-tui\todos.json
• Fallback: ./todos.json (if XDG directories aren't available)

The data is stored in JSON format and can be manually edited if needed.

Development

Running Tests

cargo test

Code Quality

cargo check
cargo clippy
cargo fmt

License

This project is open source. Feel free to use, modify, and distribute as needed.

Contributing

Contributions are welcome! Please feel free to submit a pull request.