Skip to content

A high-performance CLI Pomodoro timer with seamless real-time note-taking and an AI-driven session review dashboard.

License

Notifications You must be signed in to change notification settings

krishnakanthb13/pomodoro_cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pomodoro CLI 🍅

License: GPL v3

Pomodoro CLI

Pomodoro Stats

A high-performance, keyboard-centric Pomodoro timer designed for developers and power users who live in the terminal. Features a modern, colorful terminal UI powered by the Rich library.

✨ Features

  • Rich Terminal UI: Beautiful progress bars, color-coded time indicators, and customizable themes.
  • Live Progress Bar: Visual countdown with color transitions (Green → Yellow → Red) as time runs out.
  • Pause/Resume: Pause the timer at any time with Ctrl+P without losing your place.
  • Skip Phase: Done early? Press Ctrl+K to instantly skip the current phase and move to the next.
  • Themes & Customization: Switch between 5 stunning color schemes (cyberpunk, minimal, forest, ocean, sunset).
  • Session Templates: Save and load your favorite timer configurations for repetitive tasks.
  • Desktop Notifications: Get native system notifications when a phase ends or timer pauses.
  • Distraction-Free: Runs entirely in your terminal with a blinking cursor ready for input.
  • Integrated Note-Taking: Capture thoughts instantly without stopping the timer or switching windows.
  • Context-Aware Notes: Each note is tagged with timestamp, phase, and elapsed minutes.
  • Automated Phase Logging: Automatically records the completion of every Work, Journal, and Break phase to your notes file.
  • Dynamic Terminal Title: See current phase and remaining time in your taskbar/window title.
  • Advanced Analytics: Interactive dashboard with heatmap calendars, streak tracking, activity charts, and contextual info tooltips.
  • Accurate Focus Tracking: Measures actual time spent working by tracking intervals between your notes and phase starts.
  • Goal Setting: Set your intentions before each cycle with customizable prompt styles.
  • Cross-Platform: Native launchers for Windows (.bat, .ps1) and Linux/macOS (.sh).
  • Review System: Built-in dashboard to visualize your sessions and generate AI summaries of your day.
  • AI Summary with Full Markdown: Daily summaries render with complete markdown formatting including headings, lists, code blocks, tables, and more.
  • Compact Summary Layout: Optimized spacing (line-height 1.4) for clean, readable AI-generated summaries.
  • Collapsible Summary: Toggle Daily Summary visibility with an animated chevron button for focused review.
  • Collapsible Date Navigation: Year and month sections collapse/expand individually with smooth animations for organized browsing.
  • Quick List Controls: Collapse All/Expand All buttons for instant date list management.
  • Icon-Enhanced Navigation: All navigation buttons include relevant icons for better visual clarity.
  • Unified Page Layout: Consistent width and padding across all views for a professional appearance.
  • Enhanced Visibility: Themes now use bright color variants to ensure perfect readability on dark terminal backgrounds.
  • Organized Launcher: The pomodoro.bat launcher now features clear section headers and grouped presets for Focus, Sprints, and Tools.
  • Auto-Open Notes: Notes file opens automatically when you finish or stop the timer, or press Ctrl+O anytime during execution.

🚀 Quick Start

Installation

pip install rich pygame

Or using requirements.txt:

pip install -r requirements.txt

Windows

Double-click pomodoro.bat or pomodoro_ps.bat or run in terminal:

pomodoro.bat

Linux / macOS

./pomodoro.sh

Python (Direct)

# Standard Pomodoro: 25 min work, 5 min journal, 5 min break, 4 cycles
python pomodoro.py -w 25 -n 5 -b 5 -c 4

# Quick test: 1 min each phase, 2 cycles
python pomodoro.py -w 1 -n 1 -b 1 -c 2

# With custom chime sound
python pomodoro.py -w 25 -n 5 -b 10 -c 4 --chime mysound.wav

# Interactive sound selection
python pomodoro.py -w 25 -n 5 -b 10 -c 4 --select-chime

🎯 Command Line Options

Option Short Default Description
--work -w 25 Work duration in minutes
--note -n 5 Note-taking/Journal duration in minutes
--break -b 10 Break duration in minutes
--cycles -c 4 Number of cycles to complete
--chime None Path to .wav file for chime sound
--select-chime Interactive selection from available .wav files
--theme cyberpunk Color theme (cyberpunk, minimal, forest, ocean, sunset)
--template -t Load settings from a saved template
--save-template Save current settings as a new template
--settings Open interactive settings configuration menu
--notifications on Enable or disable desktop notifications (on/off)
--toggle-notifications Toggle notifications on/off and exit

📝 How It Works

  1. Set Your Adventure: Before each cycle, you'll be prompted to set your goals.
  2. Work Phase: A progress bar counts down while you focus. Type notes anytime and press Enter.
  3. Journal Phase: Dedicated time to capture thoughts and reflect.
  4. Break Phase: Rest before the next cycle (skipped on last cycle).
  5. Completion: Chime plays, the phase completion is logged to your notes, and desktop notification appears.
  6. Shortcuts:
    • Ctrl+P: Pause/Resume the timer.
    • Ctrl+K: Skip phase and move to the next.
    • Ctrl+O: Open notes file in your default text editor.
    • Ctrl+C: Stop the timer and open notes.
  7. Session End: Your notes file opens automatically to review your session.

🎨 Visual Features

  • Progress Bar: 52-character bar that changes color as time progresses
    • 🟢 Green: < 70% elapsed
    • 🟡 Yellow: 70-80% elapsed
    • 🔴 Red: > 80% elapsed
  • Blinking Cursor: Visual indicator that input is ready
  • Terminal Title: Always shows current phase and remaining time

📂 File Structure

├── pomodoro.py            # Main application (Python + Rich)
├── pomodoro.bat           # Windows CMD launcher
├── pomodoro.ps1           # Windows PowerShell launcher
├── pomodoro.sh            # Linux/macOS launcher
├── pomodoro.txt           # Your notes and session logs
├── pomodoro_review.html   # Review dashboard (React)
├── pomodoro_review.bat    # Review server launcher (Windows)
├── requirements.txt       # Python dependencies
└── sounds/                # Audio files for chimes

📖 Documentation

🔧 Dependencies

  • Python 3.x: Required
  • Rich: Terminal UI library (required)
  • Pygame: Audio playback (optional, falls back to system beep)

📄 License

Copyright (C) 2026 Krishna Kanth B. This project is licensed under the GNU General Public License v3.0. See LICENSE for details.

About

A high-performance CLI Pomodoro timer with seamless real-time note-taking and an AI-driven session review dashboard.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors