The Catmodoro Timer is a command-line based productivity tool built in Rust, inspired by the Pomodoro Technique. It aids in managing work sessions with set intervals, providing users with a simple interface to focus on time management effectively. The application includes features for pausing and resuming the timer, as well as the option to exit at any stage of the session.
- Customizable session durations
- Terminal-based countdown timer
- Pause and resume functionality
- Ability to exit the timer at any point
- Visual, color-coded timer status
To use the Catmodoro Timer, you must have Rust and Cargo installed on your system. For installation instructions, please refer to the Rust official installation guide.
Follow these steps to install the Catmodoro Timer:
-
Clone the repository:
git clone https://github.com/josesustaita/catmodoro.git cd catmodoro
-
Compile the project using Cargo:
cargo build --release
-
The compiled binary will be located in
target/release
. You can execute it from there or add it to your path for convenience.
Run the timer with the default setting (25 minutes) by executing the binary:
./catmodoro
For a custom session length, use the -d
or --duration
flag with the desired number of minutes:
./catmodoro -d 15
p
: Pause or resume the session.q
orEsc
: Quit the timer.
You can exit the Catmodoro Timer anytime by pressing q
or the Escape
key.
Your contributions are welcome! If you would like to contribute to the project, please feel free to make a pull request or open an issue on GitHub.
This project is released under the MIT License.