Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaelkolesidis/pomonodeoro
A simple pomodoro timer for the terminal
https://github.com/michaelkolesidis/pomonodeoro
pomodoro pomodoro-app pomodoro-cli pomodoro-technique pomodoro-technique-timer pomodoro-timer pomodoro-tracker terminal-based
Last synced: 4 days ago
JSON representation
A simple pomodoro timer for the terminal
- Host: GitHub
- URL: https://github.com/michaelkolesidis/pomonodeoro
- Owner: michaelkolesidis
- License: gpl-3.0
- Created: 2023-01-04T22:31:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-12T12:12:59.000Z (about 2 years ago)
- Last Synced: 2024-11-12T05:07:34.703Z (2 months ago)
- Topics: pomodoro, pomodoro-app, pomodoro-cli, pomodoro-technique, pomodoro-technique-timer, pomodoro-timer, pomodoro-tracker, terminal-based
- Language: JavaScript
- Homepage:
- Size: 5.48 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://nodejs.org/en/download/), 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)
```bash
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
```
3. Mode the pomonodeoro.sh to the _scripts_ folder and add your local path to the pomonodeoro.js file.
4. Now, you can run pomonodeoro from any path in your system by running:
```
pomonodeoro.sh
```
5. (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](https://www.gnu.org/licenses/gpl-3.0.html).