Skip to main content

Terminal-based Pomodoro timer with TUI and sound notifications

Project description

pomo-tui

A terminal-based Pomodoro timer with a real-time ASCII digital clock. Designed for developers who want to stay focused without leaving the terminal.


✨ Features

  • Real-time ASCII digital clock display
  • Pomodoro workflow with WORK / BREAK cycles
  • Color-coded phases
    • 🔴 WORK
    • 🔵 BREAK
    • 🟡 PAUSED
  • Keyboard control
    • p: pause / resume
    • Ctrl + C: quit
  • Terminal bell notification on phase change
  • Safe fallback rendering on small terminal windows
  • Fully terminal-based with no GUI dependency

🚀 Installation

pip

pip install pomo-tui

pipx

pipx install pomo-tui

🎯 Usage

Start with the default Pomodoro flow:

pomo

Run a custom session:

pomo --work 25 --break 5 --cycles 4

Run continuously until interrupted:

pomo --cycles 0
Option Description Default
--work Work duration in minutes 25
--break Break duration in minutes 5
--cycles Number of work/break cycles, 0 = infinite 0

Keyboard controls

Key Action
p Pause / Resume
Ctrl + C Quit

Notes

  • --work and --break must be positive integers
  • --cycles must be a non-negative integer
  • Very small terminals automatically fall back to compact text rendering

🛠️ Development Setup

git clone https://github.com/newbie1223/pomodoro-cli.git
cd pomodoro-cli
python3 -m venv .venv
source .venv/bin/activate
pip install -e .[test]
pytest

If your environment does not support extras installation yet, use:

pip install -e .
pip install pytest
pytest

📦 Package Information

  • Package name: pomo-tui
  • CLI command: pomo
  • Python requirement: >=3.9

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pomo_tui-1.1.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pomo_tui-1.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file pomo_tui-1.1.tar.gz.

File metadata

  • Download URL: pomo_tui-1.1.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for pomo_tui-1.1.tar.gz
Algorithm Hash digest
SHA256 85b2ec3d2b860c14e6125a44031558179d83b970b835404d623fe5700899f8f3
MD5 8d9428ac0977ae70511281a7cf4a09d9
BLAKE2b-256 e343dfcd4ffb78f04a19e6c73b71360cb33608be93b307805337d4e108c98b84

See more details on using hashes here.

File details

Details for the file pomo_tui-1.1-py3-none-any.whl.

File metadata

  • Download URL: pomo_tui-1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for pomo_tui-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3da257114d2f23aefc85309c66426a08f90ee76e192dbfe91104ee2927ea7f44
MD5 532bd9025c83e84377377f7ef5107822
BLAKE2b-256 e60d2856d9249b2a4e9703b2fd57a54106482b11a4de8f5835b406a351dc5373

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page