Skip to content

A simple and beautiful Pomodoro timer TUI built with Go and Bubble Tea. Manage your focus and rest periods directly from your terminal.

Notifications You must be signed in to change notification settings

helioLJ/pomotui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⏳ Pomodoro TUI

A simple and beautiful Pomodoro timer TUI (Text-based User Interface) built with Go and the Bubble Tea framework.
Manage your focus and rest periods with customizable timers directly from your terminal.

Pomodoro TUI Running


✨ Features

  • Multiple Themes: Cycle through several built-in color themes (Moon, Latte, Gruv) to customize the look and feel.
  • Preset Timers: Quickly start a session with common Pomodoro presets:
    • Pomodoro: 25 minutes of work, 5 minutes of break, 4 cycles.
    • Sprint: 15 minutes of work, 3 minutes of break, 6 cycles.
    • Focus: 50 minutes of work, 10 minutes of break, 2 cycles.
  • Custom Sessions: Define your own work duration, break duration, and number of cycles.
  • Flexible Time Input: Accepts various time formats for custom timers (e.g., 25, 45m, 1:30:00).
  • Dynamic Cycle Adjustment: Increase or decrease the total number of cycles on the fly.
  • Clean & Responsive UI: A clear layout that shows the current timer, progress bar, and overall session status.

🚀 How to Use

Prerequisites

You need to have Go installed on your system.

Running the Application

Clone the repository:

git clone https://github.com/helioLJ/pomotui.git
cd pomotui

Run directly from the source code:

go run .

Building from Source

To create a standalone executable, run the following command:

go build -o pomotui

You can then run the application with:

./pomotui

⌨️ Controls

Key(s) Action
space Start, pause, or resume the timer.
r Reset the current session to the beginning.
x Cancel the current timer and return to Idle.
[ / ] Decrease / Increase the total number of cycles.
1, 2, 3 Select a preset timer (Pomodoro, Sprint, Focus).
c Open the prompt to define a custom timer.
t Cycle through the available color themes.
q / ctrl+c Quit the application.

📝 TODO

  • Translate remaining Portuguese text and comments to English.
  • Refactor the code to improve readability and elegance, following Go standards.
  • Explore more Bubble Tea features to enhance the TUI's appearance and interactivity.
  • Add more visually awesome themes.
  • Write unit and integration tests to ensure reliability.

About

A simple and beautiful Pomodoro timer TUI built with Go and Bubble Tea. Manage your focus and rest periods directly from your terminal.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages