Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olimorris/tmux-pomodoro-plus
🍅 Incorporate the Pomodoro technique into your tmux workflow
https://github.com/olimorris/tmux-pomodoro-plus
pomodoro tmux tmux-plugin tmux-plugins
Last synced: 8 days ago
JSON representation
🍅 Incorporate the Pomodoro technique into your tmux workflow
- Host: GitHub
- URL: https://github.com/olimorris/tmux-pomodoro-plus
- Owner: olimorris
- License: mit
- Created: 2021-04-06T12:36:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T10:31:21.000Z (6 months ago)
- Last Synced: 2024-08-02T15:46:53.220Z (3 months ago)
- Topics: pomodoro, tmux, tmux-plugin, tmux-plugins
- Language: Shell
- Homepage:
- Size: 660 KB
- Stars: 276
- Watchers: 2
- Forks: 23
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-tmux - tmux-pomodoro-plus
README
Tmux Pomodoro Plus
Incorporate the Pomodoro technique into your tmux setup. Forked from Tmux Pomodoro
Please subscribe to this issue to be notified of any breaking changes to the plugin
## :sparkles: Features
- Toggle a Pomodoro and see the countdown and the break in the status bar
- Skip, pause and resume a Pomodoro/break at any point
- Customise the Pomodoro duration, break times and intervals
- Restart your Pomodoros to automatically or be prompted
- Desktop alerts for Pomodoros and breaks (MacOS and Linux only)
- Custom keybindings
## :camera: Screenshots
Pomodoro counting down:
Pomodoro on a break:
Pomodoro counting down in real-time:
Pomodoro timer menu:
## :package: Installation
1. Using [TPM](https://github.com/tmux-plugins/tpm), add the following line to your `~/.tmux.conf` file:
```bash
set -g @plugin 'olimorris/tmux-pomodoro-plus'
```
> **Note**: The above line should be _before_ `run '~/.tmux/plugins/tpm/tpm'`
2. Then press `tmux-prefix` + I (capital i, as in **I**nstall) to fetch the plugin as per the TPM installation instructions
## :rocket: Usage
### Default keybindings
- ` p` to toggle between starting/pausing a Pomodoro/break
- ` P` to cancel a Pomodoro/break
- ` _` to skip a Pomodoro/break
- ` e` to restart a Pomodoro
- ` C-p` to open the Pomodoro timer menu
- ` M-p` to set a custom Pomodoro timer
The Pomodoro timer menu and custom Pomodoro input are always `/ + [your start Pomodoro key]`.
### Status bar
To incorporate into your status bar:
```bash
set -g status-right "#{pomodoro_status}"
```
## :wrench: Configuration
> **Note**: On Linux, notifications depend on `notify-send/libnotify-bin`
The default configuration:
```bash
set -g @pomodoro_toggle 'p' # Start/pause a Pomodoro/break
set -g @pomodoro_cancel 'P' # Cancel the current session
set -g @pomodoro_skip '_' # Skip a Pomodoro/break
set -g @pomodoro_mins 25 # The duration of the Pomodoro
set -g @pomodoro_break_mins 5 # The duration of the break after the Pomodoro completes
set -g @pomodoro_intervals 4 # The number of intervals before a longer break is started
set -g @pomodoro_long_break_mins 25 # The duration of the long break
set -g @pomodoro_repeat 'off' # Automatically repeat the Pomodoros?
set -g @pomodoro_disable_breaks 'off' # Turn off breaks
set -g @pomodoro_on " 🍅" # The formatted output when the Pomodoro is running
set -g @pomodoro_complete " ✔︎" # The formatted output when the break is running
set -g @pomodoro_pause " ⏸︎" # The formatted output when the Pomodoro/break is paused
set -g @pomodoro_prompt_break " ⏲︎ break?" # The formatted output when waiting to start a break
set -g @pomodoro_prompt_pomodoro " ⏱︎ start?" # The formatted output when waiting to start a Pomodoro
set -g @pomodoro_menu_position "R" # The location of the menu relative to the screen
set -g @pomodoro_sound 'off' # Sound for desktop notifications (Run `ls /System/Library/Sounds` for a list of sounds to use on Mac)
set -g @pomodoro_notifications 'off' # Enable desktop notifications from your terminal
set -g @pomodoro_granularity 'off' # Enables MM:SS (ex: 00:10) format instead of the default (ex: 1m)
```
### Customising the status line
The output from the plugin can be customised to fit in with your statusline:
```bash
set -g @pomodoro_on "#[fg=$text_red]🍅 "
set -g @pomodoro_complete "#[fg=$text_green]🍅 "
set -g @pomodoro_pause "#[fg=$color_yellow]🍅 "
set -g @pomodoro_prompt_break "#[fg=$color_green]🕤 ? "
set -g @pomodoro_prompt_pomodoro "#[fg=$color_gray]🕤 ? "
```
The current and total number of intervals can also be displayed:
```bash
set -g @pomodoro_interval_display "[%s/%s]"
```
> **Note**: If you provide just 1 `%s` then the current interval count will be displayed only
A real-time countdown can be also be displayed:
```bash
set -g @pomodoro_granularity 'on'
set -g status-interval 1 # Refresh the status line every second
```
## :clap: Credits
- [Wladyslaw Fedorov](https://dribbble.com/Wladza) - For the squashed tomato image
## :page_with_curl: License
[MIT](https://github.com/olimorris/tmux-pomodoro-plus/blob/master/LICENSE.md)