pomo

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 12, 2025 License: MIT Imports: 2 Imported by: 0

README ยถ

pomo โ€” Terminal Pomodoro Timer

Demo

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
  • ๐Ÿ”” Cross-platform desktop notifications
  • ๐ŸŽจ Clean, minimal terminal UI
  • ๐Ÿ› ๏ธ Custom commands when timers complete

Usage

# Start a work session (default)
pomo

# Explicit work session
pomo work

# Start a break session
pomo break

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

pomo looks for its config file in:

  1. ~/.config/pomo/pomo.yaml
  2. Current directory (./pomo.yaml)

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: ./pomo.png

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
โ† / 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 ยถ

The Go Gopher

There is no documentation for this package.

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL