tasky-cli

Crates.iotasky-cli
lib.rstasky-cli
version0.3.3
created_at2025-08-29 04:36:16.961706+00
updated_at2025-09-04 06:53:18.168204+00
descriptionA simple Rust CLI to manage to-do lists
homepage
repositoryhttps://github.com/MrGranday/tasky
max_upload_size
id1815366
size48,709
Osman Ghani Granday (MrGranday)

documentation

README

Tasky CLI

A simple Rust CLI to manage to-do lists.


About

Tasky CLI is a lightweight command-line tool written in Rust for managing to-do lists. It supports adding, listing, removing, and marking tasks as done, with colorful output and JSON storage.

Designed for beginners, Tasky CLI is ideal for:

  • Learning Rust
  • Contributing to open source
  • Organizing tasks on Windows (CMD/PowerShell), Linux, or macOS

See tasky.txt for a detailed project overview.


Features

  • Add tasks:

    tasky-cli add "Buy milk"
    
  • List tasks: (colorized output)

    tasky-cli list
    
  • Remove tasks:

    tasky-cli remove 0
    
  • Mark tasks as done:

    tasky-cli done 0
    
  • JSON storage: Tasks stored in tasks.json

  • Cross-platform: Works on CMD, PowerShell, Linux, macOS

Planned features:

  • Due dates
  • Priority tags
  • JSON output enhancements

Installation

1. Install Rust

Follow the instructions at rust-lang.org or run:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  • On Windows, follow the rustup-init.exe prompts.

2. Install Tasky CLI via Cargo

cargo install tasky-cli

3. Or build from source

git clone https://github.com/MrGranday/tasky.git
cd tasky
cargo build
cargo run -- add "Test task"
cargo run -- list

4. Windows CMD color support

reg add HKCU\Console /v VirtualTerminalLevel /t REG_DWORD /d 1

Usage

# Add a new task
tasky-cli add "Finish homework"

# List all tasks
tasky-cli list

# Mark a task as done
tasky-cli done 0

# Remove a task
tasky-cli remove 0

Contributing

Tasky CLI welcomes beginners! We aim for 90%+ beginner contributors.

Steps to get started:

  1. Read CONTRIBUTING.md for guidance.

  2. Check issues for good first issue tasks, such as:

    • Adding a --done command
    • Supporting due dates
    • Improving documentation
  3. Open a pull request — no experience needed! We’ll guide you.


License

Tasky CLI is licensed under the MIT License.


Community

  • Questions: GitHub Issues
  • Join discussions: Rust Discord, r/rust
  • Share your progress: Use #rustlang or #tasky on X (Twitter)

Happy task managing! 🦀

Commit count: 41

cargo fmt