Skip to content

πŸ•’ rclock: cli stopwatch, alarm clock & Pomodoro timer πŸ•’

License

Notifications You must be signed in to change notification settings

lytexdev/rclock

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Rclock

Overview

A Rust-based command-line stopwatch, alarm clock, and Pomodoro timer.

Installation

Prerequisites

  • Rust
  • Cargo

Clone the repository

git clone https://github.com/lytexdev/rclock.git
cd rclock

Build the application

cargo build --release

The binary will be available in ./target/release/rclock.

Usage

Stopwatch

To start the stopwatch:

rclock stopwatch

With color options:

rclock stopwatch --color red

Available colors: red, green, blue, yellow, cyan, magenta, white.

Alarm

To set an alarm in seconds:

rclock alarm 60

To set an alarm at a specific time (HH:MM format):

rclock alarm 14:30

With color options:

rclock alarm 60 --color blue

The alarm will display a big "ALARM UP!" text and play a sound when triggered. Press Ctrl+C to exit.

Pomodoro Timer

The Pomodoro timer allows you to manage work and break intervals.

To start a single Pomodoro cycle (e.g., 25 minutes work, 5 minutes break):

rclock pomodoro --work 25 --break 5

To repeat the Pomodoro timer multiple times (e.g., 3 cycles):

rclock pomodoro --work 25 --break 5 --repeats 3

With color options:

rclock pomodoro --work 25 --break 5 --repeats 3 --color green

The timer will:

  • Alternate between "Work" and "Break" phases
  • Display a countdown for each phase
  • Play a sound at the end of each phase
  • Automatically transition to the next cycle

Press Ctrl+C to exit at any time.

License

This project is licensed under MIT. See the LICENSE file for details.

About

πŸ•’ rclock: cli stopwatch, alarm clock & Pomodoro timer πŸ•’

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages