README
ยถ
๐ Pom - Advanced Pomodoro Timer
A next-generation Pomodoro timer with CLI and Web UI, featuring AI insights, multi-profiles, cloud sync, and plugin system. Built with Go and pure HTML/JS.
โจ Features
๐ High-Impact Features
- ๐ Web UI Bridge - Modern HTML/JS interface with Galactic Flux theme
- ๐ฅ Multi-Profile Support - Work, study, quick, and custom profiles
- ๐ง AI-Powered Suggestions - Personalized recommendations based on performance
- ๐ Calendar Heatmap - Visual session tracking with activity levels
- ๐ค Export/Import - JSON/CSV data backup and analysis
- ๐ Cloud Sync - GitHub/Dropbox synchronization (optional)
- ๐งฉ Plugin System - Custom scripts for Notion, Slack, notifications
- ๐ Privacy Mode - Zero-data logging with local-only option
๐ฏ Core Features
- ๐ฏ Beautiful progress bar with real-time countdown
- ๐จ Multiple color themes (default, minimal, vibrant, galactic)
- ๐ Comprehensive session tracking and statistics
- ๐ฏ Daily goals with streak tracking
- ๐ Task planning and time tracking
- ๐ Cross-platform notifications and sounds
- โฏ๏ธ Pause/resume/quit functionality
- ๐ช Motivational messages and feedback
๐ Web UI - Galactic Flux Theme
Launch the modern web interface with stunning space-themed design:
# Foreground mode (blocks terminal)
pom web # Start on port 8080
pom web -p 3000 # Custom port
# True background daemon (recommended)
nohup pom web & # Background on port 8080
nohup pom web -p 3000 & # Background on custom port
# Alternative: daemon flag (still attached to terminal)
pom web -d # Shows daemon instructions
# Access web UI
# Open browser: http://localhost:8080 (or your port)
# Stop daemon: pkill pom
โ Fully Working Features:
- ๐จ Galactic Flux theme with animated glow effects
- ๐ฑ Responsive design - works on all devices
- โก Embedded in binary - no external files needed
- ๐ฏ Working timer with real-time progress visualization
- ๐ Dashboard with live stats via API
- ๐ฎ CLI Controls - all CLI commands via web interface
- ๐ Cross-platform - Windows, Mac, Linux
- ๐ Daemon mode - run in background
- ๐ง Zero dependencies - single binary solution
Color Palette:
- Background: Deep space navy (#0B0F1A)
- Primary: Neon cyan (#18FFFF)
- Secondary: Vibrant pink (#FF4081)
- Success: Emerald green (#00E676)
- Warning: Solar yellow (#FFD600)
๐ Quick Start
CLI Usage
# Basic session
pom start
# Use profiles
pom profile use work # 45min work, 10min break
pom start -p study # 30min work, 5min break
# AI insights
pom insights suggest # Get personalized recommendations
pom insights calendar # View session heatmap
# Export data
pom export json backup.json
Web Interface
# True background daemon (terminal free) โ
RECOMMENDED
nohup pom web &
nohup pom web -p 3000 & # Custom port
# Foreground mode (terminal blocked)
pom web
# Daemon instructions
pom web -d # Shows daemon setup help
# Access features:
# 1. Open browser: http://localhost:8080
# 2. Use Timer tab for Pomodoro sessions
# 3. Use CLI Controls tab for all CLI commands
# 4. Use Dashboard tab for statistics
# Stop daemon: pkill pom
Troubleshooting Web UI:
# If web UI doesn't load:
# 1. Check server is running
curl http://localhost:8080/
# 2. Test API endpoints
curl http://localhost:8080/api/profiles
# 3. Check daemon process
ps aux | grep pom
# 4. Start true daemon
nohup pom web -p 3001 &
# 5. Stop all instances
pkill pom
๐ฅ Multi-Profile System
Pre-built profiles for different work contexts:
| Profile | Work Time | Break Time | Sessions | Use Case |
|---|---|---|---|---|
default |
25min | 5min | 4 | Standard Pomodoro |
work |
45min | 10min | 3 | Deep work sessions |
study |
30min | 5min | 4 | Learning & research |
quick |
15min | 3min | 6 | Quick tasks |
pom profile list # List all profiles
pom profile use work # Switch profile
pom profile create "coding" 45 10 3 # Create custom
๐ง AI-Powered Insights
Get personalized suggestions based on your performance:
pom insights suggest # AI recommendations
pom insights today # Today's statistics
pom insights calendar # Visual heatmap
AI analyzes:
- Completion rates and patterns
- Optimal session lengths
- Best focus times
- Productivity trends
๐งฉ Plugin System
Automate workflows with custom scripts:
pom plugins list # Available plugins
pom plugins enable notion-logger # Log to Notion
pom plugins add "my-script" "echo 'Done!'" session_end
Built-in plugins:
- Notion Logger - Log sessions to Notion database
- Slack Notify - Send completion notifications
- Break Reminder - Desktop notifications with sound
- Focus Mode - Block distracting websites
๐ค Data Management
Export and sync your productivity data:
# Export
pom export json backup.json # Complete backup
pom export csv sessions.csv # Spreadsheet format
# Cloud sync
pom sync setup github # Configure GitHub sync
pom sync push # Upload data
pom sync pull # Download data
# Privacy
pom privacy enable # Zero logging mode
pom privacy clear # Delete all data
CLI Interface
Beautiful progress bar with real-time countdown
Multiple color themes (default, minimal, vibrant)
Comprehensive session tracking and analytics
Web UI - Galactic Flux Theme
Modern React interface with space-themed design
Productivity analytics
Web cli controls with session visualization
๐ง Installation
โ Available Now
Arch Linux (AUR)
yay -S pom
# or
paru -S pom
GitHub Releases
# Download latest release
curl -L https://github.com/Flack74/pom/releases/latest/download/pom-linux-amd64.tar.gz | tar xz
sudo mv pom /usr/local/bin/
From Source
git clone https://github.com/Flack74/pom.git
cd pom
go build -o pom .
sudo cp pom /usr/local/bin/
๐ง Coming Soon
Debian/Ubuntu
# Coming soon
sudo apt install pom
Fedora/RHEL
# Coming soon
sudo dnf install pom
macOS
# Coming soon
brew install pom
Windows
# Coming soon
choco install pom
Snap
# Coming soon
sudo snap install pom
Flatpak
# Coming soon
flatpak install flathub com.github.Flack74.pom
๐ ๏ธ Development
Prerequisites
- Go 1.21+
Build
# Build with embedded web UI
go build -o pom .
# Or use Makefile for version info
make build
Project Structure
pom/
โโโ cmd/ # CLI commands
โโโ config/ # Configuration & data management
โโโ logs/ # Session logging
โโโ web/ # Web UI server & HTML/JS frontend
โโโ packaging/ # Package configurations
โโโ .github/ # CI/CD workflows
๐ Privacy & Security
- Privacy Mode: Zero data logging
- Local Storage: All data stored locally
- Optional Cloud Sync: Opt-in only
- No Telemetry: No usage tracking
- Open Source: Full transparency
๐ Statistics & Analytics
Track your productivity with detailed insights:
- Daily/weekly/monthly progress
- Session completion rates
- Focus time trends
- Goal achievement tracking
- Streak monitoring
- Task-specific analytics
๐จ Themes
Choose your visual experience:
- Default: Professional and clean
- Minimal: Distraction-free
- Vibrant: Colorful and energetic
- Galactic: Space-themed (Web UI)
๐ค Contributing
- Fork the repository
- Create feature branch (
git checkout -b feature/amazing-feature) - Commit changes (
git commit -m 'Add amazing feature') - Push to branch (
git push origin feature/amazing-feature) - Open Pull Request
๐ License
MIT License - see LICENSE file for details.
๐ Acknowledgments
- The Pomodoro Techniqueยฎ by Francesco Cirillo
- Go community for excellent libraries
๐ Ready to boost your productivity? Start with pom start or pom web!
Built with โค๏ธ by Flack
Documentation
ยถ
There is no documentation for this package.