https://github.com/semanticdata/obsidian-pomodoro
A minimalist Pomodoro timer that lives in your Obsidian status bar.
https://github.com/semanticdata/obsidian-pomodoro
obsidian obsidian-plugin productivity
Last synced: about 2 months ago
JSON representation
A minimalist Pomodoro timer that lives in your Obsidian status bar.
- Host: GitHub
- URL: https://github.com/semanticdata/obsidian-pomodoro
- Owner: semanticdata
- License: mit
- Created: 2025-01-24T04:13:14.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-27T15:49:53.000Z (12 months ago)
- Last Synced: 2025-02-27T22:04:26.296Z (12 months ago)
- Topics: obsidian, obsidian-plugin, productivity
- Language: TypeScript
- Homepage:
- Size: 84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🍅 PomoBar
**_The Minimalist Pomodoro Timer for Obsidian._**
Boost your productivity and maintain focus without ever leaving your notes. PomoBar is a sleek, unobtrusive Pomodoro timer that lives in your Obsidian status bar, with optional audio notifications to keep you on track. Seamlessly integrate the Pomodoro Technique into your workflow with visual and audible cues.
| Default View | Running View |
| :------------------------------------------------------------: | :------------------------------------------------------------: |
|  |  |
| _Also available with icons!_ | _...and they change when running!_ |
|  |  |
## Why Choose 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.
- 🔊 **Optional Audio Notifications:** Get gentle sound alerts when timers complete—choose from default sounds or use your own custom audio files.
- 🖱️ **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.
## How It Works
The timer appears in your status bar. Here’s how to use it:
- **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).
For more detailed instructions, check out our [documentation](https://semanticdata.github.io/obsidian-pomodoro/).
## ⌨️ Keyboard-Friendly Commands
For our keyboard-centric users, PomoBar includes a comprehensive set of commands that allow you to control the timer without touching your mouse. You can assign custom hotkeys to these commands in Obsidian's settings for a truly personalized and efficient workflow.
- **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 status bar icon display.
## Installation
### From Obsidian Community Plugins (Recommended)
1. Open **Settings** → **Community Plugins** in Obsidian.
2. Disable **Safe Mode** if it's enabled.
3. Click **Browse** and search for "PomoBar".
4. Click **Install**, and then **Enable** the plugin.
### Manual Installation
1. Download the latest release files (`main.js`, `manifest.json`, `styles.css`) from the [releases page](https://github.com/semanticdata/obsidian-pomodoro/releases).
2. Create a new folder named `pomobar` inside your vault's `.obsidian/plugins/` directory.
3. Copy the downloaded files into this new folder.
4. Reload Obsidian (Ctrl/Cmd + R) and enable the plugin in the settings.
## Community & Contributions
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.
- **Source Code:** The complete source code is available on [GitHub](https://github.com/semanticdata/obsidian-pomodoro).
- **Contribute:** Have an idea or a bug fix? See our [contribution guidelines](https://github.com/semanticdata/obsidian-pomodoro/blob/master/CONTRIBUTING.md) to get started.
- **License:** The project is licensed under the [MIT License](https://github.com/semanticdata/obsidian-pomodoro/blob/master/LICENSE).