Skip to content

πŸ…πŸ¦€ A yassified CLI Pomodoro timer written in pure rust for all your procrastination needs.

Notifications You must be signed in to change notification settings

MigraineBuddy/red-tomatoes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

36 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

β²οΈπŸ… Red-Tomatoes πŸ˜©πŸ’…

About πŸ“

Red-Tomatoes is a command line timer app mainly built on the Console and Clap crates. Designed while I was procrastinating to avoid procrastinating. (I still ended up procrastinating btw 😭)

Installation πŸ› οΈ

Through Cargo πŸ“¦

Requires a rust installation to build.

# Clone repository to any given folder.
git clone https://github.com/MigraineBuddy/red-tomatoes.git

# Change directory to repo clone
cd ./red-tomatoes/

# Cargo will do the rest of the heavy lifting.
cargo build -r && cargo install --path .

Manual install πŸ’ͺ

Note: Only available on Windows for now. Download the latest release and run directly. A rust install shouldn't be necessary.

./red-tomatoes.exe --help

Uninstall πŸ—‘οΈ

You will be missed πŸ˜” <3

cargo uninstall red-tomatoes

# To delete the cloned repo from the command line.
rm -rf ./red-tomatoes/

Usage πŸ€“β˜οΈ

The red-tomatoes command comprises two subcommands that you need to know about: pomodoro, which is a standard pomodoro timer with default work and break time durations, and timer, which you can use as a standard timer.

# Basic timer usage. (duration is in seconds)
red-tomatoes timer --timer-name "Boiling an egg." --duration 900

# Pomodoro timer usage. it'll run the default Pomodoro timer if ran without any arguments.
# Work (25 mins) -> Short Break (5 mins) -> Work -> Short Break -> Work -> Long Break (15 mins)
red-tomatoes pomodoro

# For more info.
red-tomatoes --help 

Under Construction 🚧:

  • Add pause and stop buttons.
  • Refactor the code to make it neater.
  • Add a progress bar for the timer and Pomodoro.
  • Incorporate color configuration for timers into the structs.
  • Divide the code into multiple different files.
  • Add cutesy animations and other tweaks to enhance the user experience.
  • Add desktop notifications.

About

πŸ…πŸ¦€ A yassified CLI Pomodoro timer written in pure rust for all your procrastination needs.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages