Quick Start¶

Get TinyMonitor running in under 5 minutes.

1. Install¶

curl -sSL https://raw.githubusercontent.com/Gu1llaum-3/tinymonitor/main/install/install.sh | bash

2. Configure¶

Edit /etc/tinymonitor/config.toml (Linux) or ~/.config/tinymonitor/config.toml (macOS):

refresh = 5
cooldown = 60

[cpu]
enabled = true
warning = 70
critical = 90

[memory]
enabled = true
warning = 80
critical = 95

[alerts.ntfy]
enabled = true
topic_url = "https://ntfy.sh/my-alerts"

3. Test¶

# Validate your configuration
tinymonitor validate

# Send a test alert
tinymonitor test-alert

4. Run¶

# Foreground (for testing)
tinymonitor

# As a service (Linux)
sudo tinymonitor service install

Next Steps¶

• Full Installation Guide - Manual installation, build from source
• First Configuration - Detailed configuration walkthrough
• Configuration Reference - All available options
• CLI Commands - All available commands