Skip to content

michaelkolesidis/pomonodeoro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pomonodeoro 🍅

A simple pomodoro timer for the terminal. Choose between a pomodoro, a short or a long break and get a system notification when the time is over. Works on Linux, macOS and Windows.

Setup

First, you need to download and install Node.js, as well as, install Yarn globally.

Then, clone or download the project, and while inside its main folder run the following command to build the pomonodeoro.js file containing the src.js file bundled with all the dependencies (no external dependencies)

yarn build

You might want to be able to run Pomonodeoro from the terminal, from anywhere in your system. To achieve that follow these steps:

  1. Create a folder named scripts (or anything you want) inside your home folder.
  2. Add this line to the basrc file located in your home folder:
export PATH=$PATH:~/scripts
  1. Mode the pomonodeoro.sh to the scripts folder and add your local path to the pomonodeoro.js file.
  2. Now, you can run pomonodeoro from any path in your system by running:
pomonodeoro.sh
  1. (optional) Rename the pomonodeoro.sh file to something simpler (ex. pomodoro) to be able to run Pomonodeoro writing a simpler command each time.

How to Use

When you run Pomonodeoro you can choose one of the following options:

Key Function
P Start new pomodoro (25 minutes)
S Start new short break (5 minutes)
L Start new long break (20 minutes)
E Exit

License

Copyright (c) 2023 Michael Kolesidis
Licensed under the GNU General Public License v3.0.