todoz
| Crates.io | todoz |
| lib.rs | todoz |
| version | 1.1.0 |
| created_at | 2025-06-10 22:32:46.839464+00 |
| updated_at | 2025-06-11 11:05:42.439043+00 |
| description | A mindful CLI task manager blending zen aesthetics with modern functionality |
| homepage | |
| repository | https://github.com/sangeeth-606/todoZ |
| max_upload_size | |
| id | 1707821 |
| size | 32,942 |
ZAPE (sangeeth-606)
documentation
README
TodoZ - A Simple Command-Line Todo Application
TodoZ is a fast, lightweight command-line todo list manager written in Rust. It helps you keep track of your tasks with a simple and intuitive interface.
Features
- Create tasks - Add tasks with descriptive text
- Mark tasks as completed - Toggle completion status with a simple command
- Delete tasks - Remove individual tasks or clear all tasks
- Persistence - Tasks are automatically saved to disk
- User-friendly interface - Simple commands and intuitive display
- Cross-platform - Works on Linux, macOS, and Windows
Installation
Prerequisites
- Rust and Cargo (1.50.0 or later)
From Source
-
Clone the repository:
git clone https://github.com/yourusername/todoz.git cd todoz -
Build the application:
cargo build --release -
Add to your PATH (optional):
# For Linux/macOS cp target/release/todoz ~/.local/bin/ # For Windows (PowerShell) # Copy-Item .\target\release\todoz.exe -Destination "$env:USERPROFILE\AppData\Local\Microsoft\WindowsApps"
Using Cargo
cargo install --git https://github.com/sangeeth-606/todoz.git
Usage
Start the application:
todoz
Commands
| Command | Description |
|---|---|
list |
Show all tasks |
add <task> |
Add a new task |
x <id> |
Toggle task completion status |
rm <id> |
Remove a task |
rm-all |
Remove all tasks |
help |
Show help message |
quit |
Exit the application |
Examples
> add Buy groceries
Task added!
1 [ ]: Buy groceries
> add Finish report
Task added!
1 [ ]: Buy groceries
2 [ ]: Finish report
> x 1
Task 1 toggled!
1 [x]: Buy groceries
2 [ ]: Finish report
> rm 2
Task 2 removed!
1 [x]: Buy groceries
Data Storage
TodoZ saves your tasks in ~/.todoz/todos.json (Linux/macOS) or %USERPROFILE%\.todoz\todos.json (Windows).
Build from Source
# Clone the repository
git clone https://github.com/sangeeth-606/todoZ
cd todoz
# Build
cargo build --release
# Run tests
cargo test
# Run the application
cargo run
Dependencies
- serde - For serializing and deserializing data
- serde_json - For JSON handling
- dirs - For platform-specific directory paths
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the project
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
- Inspired by various command-line todo applications
- Built with Rust 🦀