Introduction
Welcome to the documentation for PomoBar, a Pomodoro timer plugin for Obsidian.
This plugin is designed to help you focus and be more productive by integrating a Pomodoro timer directly into your Obsidian workspace.
| Default View | Running View |
|---|---|
 |  |
| Also available with icons! | ...and they change when running! |
 |  |
What is PomoBar?
PomoBar is designed to be the simplest possible Pomodoro timer for Obsidian users. It integrates seamlessly into your workflow by placing a countdown timer directly in the status bar, requiring minimal screen real estate while providing maximum functionality.
Key Features
- 🎯 Status Bar Integration: Timer lives in your status bar - always visible, never intrusive
- ⏱️ Traditional Pomodoro: 25-minute work sessions with 5/15-minute breaks
- 🖱️ Simple Controls: Left click to start/stop, middle click to cycle durations, right click to reset
- 🔄 Automatic Cycling: Seamlessly transitions between work and break periods
- ⚙️ Fully Configurable: Customize all timer durations and behavior
- 📱 Minimal Design: Clean interface that matches Obsidian's aesthetic
Quick Start
- Install the plugin from Obsidian's Community Plugins
- Learn the controls - three simple mouse clicks control everything
- Customize settings to match your preferred work rhythm
- Start being more productive with focused work sessions!
Documentation Overview
This documentation covers everything you need to know about PomoBar:
| Section | Description |
|---|---|
| Installation | Step-by-step installation from Community Plugins or manual setup |
| Usage Guide | Complete guide to controls, timer states, and workflow |
| Configuration | All available settings with examples and use cases |
| Customization | Advanced customization for timer behavior and appearance |
| Troubleshooting | Solutions for common issues and advanced debugging |
| Development | Developer setup, architecture, and contribution guidelines |
| API Reference | Technical documentation for developers and advanced users |
The Pomodoro Technique
The Pomodoro Technique is a time management method that uses focused work intervals (traditionally 25 minutes) separated by short breaks. This approach helps maintain concentration and prevents burnout during long work sessions.
PomoBar's default cycle:
- 🍅 Work: 25 minutes of focused work
- ☕ Short Break: 5 minutes of rest
- 🍅 Work: Another 25-minute session
- ☕ Short Break: Another 5-minute rest
- Repeat 2 more times...
- 🛋️ Long Break: 15 minutes of extended rest
After 4 work sessions, you get a longer break to recharge before starting the cycle again.
Why Choose PomoBar?
🚀 Lightweight & Fast
- Minimal resource usage
- No complex UI or distracting animations
- Integrates perfectly with Obsidian's performance
🎨 Obsidian Native
- Matches your theme automatically
- Uses standard Obsidian UI patterns
- No external dependencies
🛠️ Highly Configurable
- Adjust all timer durations
- Control visual elements
- Customize work/break cycles
📊 Focus on Productivity
- No complex analytics or tracking
- Simple notifications when timers complete
- Encourages consistent work habits
Getting Help
- Common Issues: Check the Troubleshooting guide
- Bug Reports: Open an issue on GitHub
- Feature Requests: Discuss on the GitHub repository
- Development: See the Development Guide for contributing
License & Contributing
PomoBar is open source software released under the MIT License. We welcome contributions! See our Development Guide for details on how to get started.
Ready to boost your productivity? Start with the Installation Guide to get PomoBar set up in your Obsidian vault!