README
¶
pomo — Terminal Pomodoro Timer
A simple, customizable Pomodoro timer for your terminal, built with Bubble Tea.
Features
- 🍅 Work and break timer sessions
- 📊 Real-time progress bar visualization
- ⌨️ Keyboard shortcuts to adjust time mid-session
- ⏸️ Pause and resume timer functionality
- 🖥️ Optional full screen or inline mode
- 🔔 Cross-platform desktop notifications
- 🎨 Clean, minimal terminal UI
- 🛠️ Custom commands when timers complete
Usage
Work sessions:
pomo # Default work session (25m)
pomo 30m # Custom duration
pomo long # Long work session (45m)
Break sessions:
pomo break # Default break (5m)
pomo break 10m # Custom duration
pomo long-break # Long break (15m)
Installation
Install with Go
go install github.com/Bahaaio/pomo@latest
Or, build from source
git clone https://github.com/Bahaaio/pomo
cd pomo
go build .
Alternatively, download pre-built binaries from the releases page.
Configuration
📁 Config file search order
pomo looks for its config file in the following order:
- Current directory:
pomo.yaml(highest priority) - System config directory:
- Linux:
~/.config/pomo/pomo.yaml - macOS:
~/Library/Application Support/pomo/pomo.yaml - Windows:
%APPDATA%\pomo\pomo.yaml
- Linux:
- Built-in defaults if no config file is found
Example pomo.yaml:
fullScreen: true
work:
duration: 25m
title: work session
# cross-platform notifications
notification:
enabled: true
title: work finished 🎉
message: time to take a break
icon: ~/my/icon
break:
duration: 5m
# will run after the session ends
then:
- spd-say 'Back to work!'
Check out pomo.yml for a full example with all options.
Key Bindings
| Key | Action |
|---|---|
↑ / k |
Increase time by 1 minute |
↓ / j |
Decrease time by 1 minute |
Space |
Pause/Resume timer |
← / h |
Reset to initial duration |
q / Ctrl+C |
Quit |
License
This project is licensed under the MIT License. See the LICENSE file for details.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd provides the command-line interface for the pomo timer.
|
Package cmd provides the command-line interface for the pomo timer. |
|
Package config loads, stores, and provides default values for work and break tasks.
|
Package config loads, stores, and provides default values for work and break tasks. |
|
Package ui provides the terminal user interface for pomodoro sessions.
|
Package ui provides the terminal user interface for pomodoro sessions. |
Click to show internal directories.
Click to hide internal directories.