Skip to content

saranshbarua/flumen

Repository files navigation

🌊 Flumen for macOS

Status Platform License

A beautiful, free focus timer for macOS. Lives in your menu bar, stores data locally, and stays out of your way. No bloat, no paywalls, no cloud.

Flumen for macOS


💾 Download

To install and run the app:

  1. Download the Flumen_macOS_Universal.zip from the link above.
  2. Unzip the file to your Applications folder.
  3. Right-click Flumen.app and select Open.
  4. Click Open again in the security dialog (this is required for the first launch as the app is currently ad-hoc signed).

Tip

If macOS blocks the app or asks to move it to the Bin:

  1. Open System Settings > Privacy & Security.
  2. Scroll down to the Security section.
  3. You will see a message: "Flumen.app was blocked from use because it is not from an identified developer."
  4. Click Open Anyway and enter your password if prompted.

✨ Features

🍏 Native macOS Presence

  • Menu Bar Companion: Mirror your remaining time directly in the macOS menu bar for glanceable tracking.
  • Floating Popup: Popover-style interface that stays on top when you need it without stealing focus.
  • Global Shortcuts: Toggle visibility from anywhere with ⌥⇧P (Option+Shift+P).
  • Space-Aware: The timer follows you across Mission Control spaces automatically.

📊 Integrated Analytics & Tasks

  • Task Focused: A slide-up "Task Shelf" to manage your session goals without distraction.
  • Project Tagging: Categorize your focus sessions with project-level tags to see where your time goes.
  • Deep Insights: Detailed bar charts, project distribution lists, and streak tracking.
  • CSV Export: Export your focus data to CSV for external analysis.
  • Native Persistence: Your logs and tasks are saved to a native SQLite database, surviving updates and restarts.
  • Automatic Logging: Focus time is logged automatically every minute and on session completion.

📸 Visual Showcase

Focus Mode Task Shelf Reports & Insights
Main Timer Task Shelf Reports
Long Break Short Break Settings
Long Break Short Break Settings

🛠 Tech Stack


🏗 Build from Source

Prerequisites

  • macOS 13+ (Ventura or later)
  • Node.js & npm
  • Xcode Command Line Tools (xcode-select --install)

Development Steps

  1. Clone the repository:
    git clone https://github.com/saranshbarua/flumen.git
    cd flumen
  2. Install Dependencies:
    npm install
  3. Build the Universal Binary:
    sh build_app.sh
    This will generate Flumen.app and a distribution ZIP in the project root.

📖 Documentation

Explore the technical details:


🤝 Contributing

We welcome contributions! Whether you're fixing a bug, suggesting a feature, or improving documentation, we appreciate your help. Please see our CONTRIBUTING.md for:

  • Conventional Commits: We follow strict commit naming conventions.
  • Development Workflow: How to set up and run the project locally.
  • Testing: How to run our Vitest suite.
  • Release Process: How we automate builds and deployments.

📄 License

This project is licensed under a custom Non-Commercial Share-Alike license. It is free for personal use and internal work productivity, but selling the software or redistributing it for commercial gain is strictly prohibited. Any modifications must also be shared under the same terms. See the LICENSE file for the full legal text.


Built with ❤️ for deep thinkers.

About

A beautiful, native focus companion for macOS designed to help you stay focused and track your progress across projects. Completely free. Forever.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Sponsor this project

  •  

Contributors