pom

command module
v1.0.3-0...-7e9eecf Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2025 License: MIT Imports: 1 Imported by: 0

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.

Go Cobra CLI Pom Web UI Version License

โœจ 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

image Beautiful progress bar with real-time countdown

image Multiple color themes (default, minimal, vibrant)

image Comprehensive session tracking and analytics

Web UI - Galactic Flux Theme

image Modern React interface with space-themed design

image Productivity analytics

image 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

  1. Fork the repository
  2. Create feature branch (git checkout -b feature/amazing-feature)
  3. Commit changes (git commit -m 'Add amazing feature')
  4. Push to branch (git push origin feature/amazing-feature)
  5. 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 ยถ

The Go Gopher

There is no documentation for this package.

Directories ยถ

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL