https://github.com/dhth/pomm
A no-frills pomodoro progress indicator for tmux
https://github.com/dhth/pomm
pomodoro tmux
Last synced: over 1 year ago
JSON representation
A no-frills pomodoro progress indicator for tmux
- Host: GitHub
- URL: https://github.com/dhth/pomm
- Owner: dhth
- Created: 2024-05-13T17:49:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-20T08:47:45.000Z (about 2 years ago)
- Last Synced: 2024-05-20T09:55:49.708Z (about 2 years ago)
- Topics: pomodoro, tmux
- Language: Go
- Homepage:
- Size: 219 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pomm
✨ Overview
---
`pomm` is a no-frills pomodoro progress indicator intended for tmux and similar
terminal multiplexers.
A running timer:
Once the timer finishes:
🤔 Why
---
There are a lot of good pomodoro timers out there. I needed a super simple timer
which could display its progress in tmux's status bar (as that's where I spend
most of my time). I'm sure many of the other options can do that, I just felt
that writing one myself would be faster than trying to make the other tools work
as I need them to.
💾 Install
---
**go**:
```sh
go install github.com/dhth/pomm@latest
```
⚡️ Usage
---
### Basic Usage
- Add the following to your tmux config (or modify it accordingly)
```
set -g status-right "#(pomm)"
```
- Ensure that your tmux status bar is set to be refreshed at a reasonable
interval
```
set -g status-interval 60
```
- Start a pomodoro timer with `pomm -s`
- Go on a break with `pomm -b`
### Notifying on Completion
`pomm` can run a shell command when the timer goes off. The default is `tmux
display -d 2000 "fin!"`. Configure it via:
```bash
pomm -n -nc='tmux::display-message::-d::2000::"hey, go take a break!"'
```
*`-n` dictates whether the notify command will actually run or not*
### Turn Indicator Off
```bash
pomm -o
```