🚀 Quick Install (Recommended)

One-line installer for macOS and Linux systems

# macOS/Linux
curl -fsSL https://raw.githubusercontent.com/ferg-cod3s/rune/main/install.sh | bash

🍺 Homebrew (macOS)

Install via Homebrew package manager

brew install --cask ferg-cod3s/tap/rune

🐹 Go Install

Build from source with Go toolchain

go install github.com/ferg-cod3s/rune/cmd/rune@latest

📦 Manual Installation

Download and install manually

1. Download from GitHub Releases
2. Extract binary and move to your PATH
3. Make executable: chmod +x rune

🪟 Windows Installation

Download the Windows binary from GitHub Releases and add to your PATH.

1️⃣ Initialize Configuration

Interactive setup to configure your work environment

rune init --guided

This setup configures:

• Work hours and break intervals
• Project detection rules
• Start/stop rituals
• Integration preferences

2️⃣ Verify Installation

Confirm everything is working correctly

rune --version
rune status

🚀 Start Your Workday

# Start tracking and enable focus mode
rune start
Check current status
rune status

⏸️ Take Breaks

# Pause for a break
rune pause
Resume work
rune resume

🏁 End Your Day

# Stop tracking and generate report
rune stop

📊 Daily Reports

# View today's report
rune report --today

📈 Weekly Reports

# View this week's report
rune report --week

📅 Custom Date Range

# View specific date range
rune report --from 2024-01-01 --to 2024-01-07

⚙️ Edit Configuration

# Edit configuration file
rune config edit

✅ Validate Settings

# Validate configuration
rune config validate

👀 View Current Config

# Show current configuration
rune config show