PomoBar Documentation
A minimalist Pomodoro timer for Obsidian that keeps you focused on what matters.
PomoBar integrates the Pomodoro Technique directly into your Obsidian workflow, helping you maintain productive work sessions without ever leaving your notes. The timer lives in your status bar—unobtrusive yet always visible—so you can stay on track without distractions.
Quick Start
- Install the plugin from Obsidian's Community Plugins
- Learn the controls - three simple mouse clicks control everything
- Customize your settings to match your work rhythm
- Start being more productive with focused work sessions!
✨ Key Features
🧘 Unobtrusive Design
PomoBar lives in your status bar, providing a constant but subtle reminder of your work session without cluttering your workspace. No pop-ups, no distractions—just focus.
🔊 Optional Audio Notifications
Get gentle sound alerts when timers complete. Choose from built-in sounds or upload your own custom audio files from your vault.
🖱️ Intuitive Controls
Manage your timers with simple mouse interactions:
- Left-click - Start or pause the timer
- Middle-click - Cycle between work, short break, and long break
- Right-click - Reset the current timer
⌨️ Keyboard-Friendly
Prefer keyboard shortcuts? PomoBar includes comprehensive commands that you can assign to custom hotkeys in Obsidian's settings:
- Start/Pause timer
- Reset current timer
- Cycle to next timer duration
- Toggle sound notifications
- Toggle status bar visibility
- Toggle icon visibility
🔄 Automated Flow
Optional auto-progression automatically starts the next timer in your Pomodoro cycle, or pause after each session for manual control—whatever works best for your workflow.
⚙️ Fully Customizable
Custom-tune every aspect of your work rhythm:
- Work session duration
- Short and long break durations
- Number of intervals before long break
- Sound selection and volume
- Visual elements (icons, status bar)
- Auto-progress behavior
📖 Documentation
Installation & Setup
- Installation Guide - Get PomoBar running in your vault
- Configuration Guide - Customize your timers and preferences
Usage
- User Guide - Learn all the controls and features
- Troubleshooting - Solutions to common issues
Development
- Development Guide - Contributing and extending PomoBar
- API Reference - Plugin API documentation (for developers)
🎯 Why Choose PomoBar?
| Feature | PomoBar | Other Timers |
|---|---|---|
| Status Bar Integration | ✅ Native, always visible | ❌ Separate windows or pop-ups |
| Custom Audio | ✅ Vault files or URLs | ⚠️ Limited to built-in sounds |
| Keyboard Shortcuts | ✅ Full command set | ⚠️ Limited or none |
| Auto-Progress | ✅ Optional, configurable | ⚠️ All-or-nothing |
| Theme Matching | ✅ Automatic | ⚠️ May clash with themes |
| Resource Usage | ✅ Minimal | ⚠️ Often heavy |
| Complexity | ✅ Simple, focused | ❌ Overengineered |
🎨 Visual Tour
Clean & Minimal
The timer sits unobtrusively in your status bar.
Active Sessions
Running timers are clearly highlighted.
Icon Mode
Enable icons for a cleaner look.
Dynamic Icons
Icons change to show timer state.
💬 Community & Support
- Bug Reports: Open an issue on GitHub
- Feature Requests: Start a discussion on the GitHub repository
- Questions: Check the Troubleshooting guide first
📜 License
PomoBar is open source software released under the MIT License.
Ready to boost your productivity? Start with the Installation Guide to get PomoBar set up in your Obsidian vault!