https://github.com/tuc0w/pomodorojs
https://github.com/tuc0w/pomodorojs
cli javascript nodejs pomodoro pomodoro-cli pomodoro-technique pomodoro-timer pomodoro-tracker terminal vscode
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tuc0w/pomodorojs
- Owner: tuc0w
- License: mit
- Created: 2021-02-24T09:42:56.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T13:13:03.000Z (about 2 years ago)
- Last Synced: 2025-10-13T09:38:29.263Z (8 months ago)
- Topics: cli, javascript, nodejs, pomodoro, pomodoro-cli, pomodoro-technique, pomodoro-timer, pomodoro-tracker, terminal, vscode
- Language: JavaScript
- Homepage:
- Size: 224 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pomodorojs
## About
A customizable pomodoro timer for your terminal
---
## Usage
Install the dependencies
```bash
yarn install
# or
npm install
```
Start the timer
```bash
yarn start
# or
npm run start
```
Output during work:
![Output during work][work]
Output during pause:
![Output during pause][pause]
To pause hit the p key, to resume work hit the p key again.
To quit and write the logs hit the q key.
The logs will be saved as a json file within the `logs/` directory, the filename will be the current ISO time, a sample log looks like this:
```json
{
"task": "Test",
"targetHours": "3",
"blockLength": "24",
"breakLength": "6",
"timeEntries": [
[
{
"isBreak": false,
"seconds": 6,
"start": "2021-02-25T00:04:24.034Z",
"end": "2021-02-25T00:04:30.360Z"
},
{
"isBreak": true,
"seconds": 6,
"start": "2021-02-25T00:04:30.360Z",
"end": "2021-02-25T00:04:37.031Z"
}
]
]
}
```
---
## Credits
Inspired by the article https://js.plainenglish.io/build-a-command-line-pomodoro-timer-in-node-js-65ed2f6d3308
[work]: /docs/images/work.png "output during work"
[pause]: /docs/images/pause.png "output during pause"