README file from
Github🍅 PomoBar
The Minimalist Pomodoro Timer That Keeps You Focused in Obsidian
Boost your productivity without ever leaving your notes. PomoBar is a sleek, unobtrusive Pomodoro timer that lives in your status bar—with optional audio notifications to keep you on track. Seamlessly integrate the Pomodoro Technique into your workflow with visual and audible cues.
✨ Why PomoBar?
🧘 Stay Focused, Not Distracted
PomoBar lives in your status bar, providing a constant but subtle reminder of your work session without cluttering your workspace or interrupting your flow.
🔊 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 & Quick Controls
Manage your timers with simple clicks—no need to open new windows or type commands.
🔄 Automated Flow
Optional auto-progression automatically starts the next timer in your Pomodoro cycle, or pause after each session for manual control.
⚙️ Your Rhythm, Your Rules
Deep work sessions aren't one-size-fits-all. Custom-tune your work/break intervals to match your energy levels.
📸 See It In Action
| Default View | Running View |
|---|---|
 |
 |
| Also available with icons! | ...and they change when running! |
 |
 |
🎮 How It Works
The timer appears in your status bar. Control everything with simple mouse clicks:
- Left-click - Start or pause the timer
- Middle-click - Instantly cycle between work, short break, and long break timers
- Right-click - Reset the current timer (when paused)
⌨️ Keyboard-Friendly Commands
Prefer keyboard shortcuts? PomoBar includes comprehensive commands you can assign to custom hotkeys in Obsidian's settings:
| Command | Description |
|---|---|
| Start/Pause timer | Toggle the timer on or off |
| Reset current timer | Reset the timer for the current session |
| Cycle to next timer duration | Switch between work, short break, and long break |
| Toggle sound notifications | Enable or disable audio alerts on the fly |
| Toggle status bar visibility | Show or hide the timer display |
| Toggle icon visibility | Control the status bar icon display |
For more detailed instructions, check out our full documentation.
⚙️ Configurable to Your Needs
PomoBar adapts to your unique work style:
- Flexible Durations - Customize work, short break, and long break durations
- Cycle Control - Set how many work sessions before a long break
- Audio Options - Choose from 6 built-in sounds or use your own files
- Volume Control - Adjust sound volume to your preference
- Visual Preferences - Show/hide icons and the entire status bar timer
- Auto-Progress - Automatically start the next session or pause for manual control
🚀 Installation
From Obsidian Community Plugins (Recommended)
- Open Settings → Community Plugins in Obsidian
- Disable Safe Mode if it's enabled
- Click Browse and search for "PomoBar"
- Click Install, then Enable the plugin
Manual Installation
- Download the latest release files (
main.js,manifest.json,styles.css) from the releases page - Create a new folder named
pomobarinside your vault's.obsidian/plugins/directory - Copy the downloaded files into this new folder
- Reload Obsidian (Ctrl/Cmd + R) and enable the plugin in the settings
💬 Community & Support
PomoBar is a free and open-source project built for the Obsidian community. We believe in the power of collaboration and welcome contributions of all kinds. Whether you're a developer, a designer, or just an enthusiastic user, you can help shape the future of this plugin.
- 📖 Documentation - Full documentation
- 🐛 Bug Reports - Report an issue
- 💡 Feature Requests - Start a discussion
- 🔧 Contributing - Contribution guidelines
- 📜 License - MIT License
Ready to boost your productivity? Install PomoBar from the Obsidian Community Plugins marketplace today!