Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcoplaitano/pomodoro-bash
A simple Bash pomodoro timer
https://github.com/marcoplaitano/pomodoro-bash
bash pomodoro pomodoro-bash pomodoro-script pomodoro-technique pomodoro-technique-timer pomodoro-timer shell-script
Last synced: about 8 hours ago
JSON representation
A simple Bash pomodoro timer
- Host: GitHub
- URL: https://github.com/marcoplaitano/pomodoro-bash
- Owner: marcoplaitano
- License: mit
- Created: 2024-02-08T17:09:37.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-02-13T08:09:07.000Z (9 months ago)
- Last Synced: 2024-02-13T09:24:58.089Z (9 months ago)
- Topics: bash, pomodoro, pomodoro-bash, pomodoro-script, pomodoro-technique, pomodoro-technique-timer, pomodoro-timer, shell-script
- Language: Shell
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pomodoro Timer
This Bash [Pomodoro Timer](https://www.pomodorotechnique.com/what-is-the-pomodoro-technique.php)
is a simple command-line tool to help users implement the Pomodoro Technique, a
time management method that uses a timer to break down work into intervals,
separated by short breaks.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
## Usage
1. Clone the repository and make the script executable:
```sh
git clone https://github.com/marcoplaitano/pomodoro-bash
cd pomodoro-bash
chmod +x pomodoro.sh
```
2. Run the pomodoro timer:
```sh
./pomodoro.sh
```
By default, it alternates between *Focus* slices of **25** minutes and *Pauses*
of **5**.
After **3** iterations, a *Long Pause* of **20** minutes is earned.
The timer can be controlled with case-**in**sensitive key presses:
+ `P` to pause or resume (`SPACE` works too)
+ `N` to skip to the next slice
+ `Q` to quit the script
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
## Configuration
Open the `pomodoro.sh` file to edit the following variables:
+ **TIMES**
Duration (in minutes) of each slice
```sh
declare -A TIMES=(
[FOCUS]=25
[PAUSE]=5
[LONG PAUSE]=20
)
```
+ **NUM_ITERATIONS**
Number of *Focus* slices to complete before a *Long Pause* is earned
```sh
NUM_ITERATIONS=3
```
+ **SOUNDS**
Sounds to play when notifying the beginning of a new slice
```sh
declare -A SOUNDS=(
[FOCUS]="/usr/share/sounds/focus.oga"
[PAUSE]="/usr/share/sounds/pause.oga"
[LONG PAUSE]="/usr/share/sounds/pause.oga"
)
```
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
## Author
Marco Plaitano
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
## License
Distributed under the [MIT](LICENSE) license.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
## Acknowledgments
Pomodoro Technique: https://www.pomodorotechnique.com/what-is-the-pomodoro-technique.php