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
- 🖥️ Optional full screen or inline mode
- 🔔 Custom commands when timers complete (notifications, etc.)
- 🎨 Clean, minimal terminal UI
Installation
git clone https://github.com/Bahaaio/pomo
cd pomo
go build .
Configuration
pomo looks for its config file in:
~/.config/pomo/pomo.yaml- Current directory (
./pomo.yaml)
Example pomo.yaml:
fullScreen: true
work:
duration: 25m
then:
- notify-send "Work Finished!" "Time to take a break ☕"
break:
duration: 5m
then:
- notify-send "Break Over" "Back to work! 💪"
The then field contains shell commands that run when the timer finishes.
Usage
# Start a work session (default)
./pomo
# Explicit work session
./pomo work
# Start a break session
./pomo break
Key Bindings
| Key | Action |
|---|---|
↑ / k |
Increase time by 1 minute |
↓ / j |
Decrease time by 1 minute |
← / 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.