Introduction
Watchdog provides a powerful command-line interface (CLI) for monitoring HTTP endpoints. The CLI allows you to add URLs for monitoring, view their status, analyze uptime metrics, and manage your monitoring configuration.Installation
The Watchdog CLI is the main entry point for the application. After building the project, you can run commands using:Available commands
Watchdog provides the following commands:- guard (g) - Start the monitoring process
- add (a) - Add a URL to monitor
- remove (rm) - Remove a URL from monitoring
- list (ls) - List all monitored URLs
- analysis (an) - View detailed analytics for a monitored URL
Getting help
To see all available commands:Command aliases
Most commands have short aliases to speed up your workflow:guard→gadd→aremove→rmlist→lsanalysis→an
Common usage patterns
Starting the monitoring service
Start Watchdog to begin monitoring all configured URLs:Adding and managing URLs
Add a new URL to monitor:Viewing analytics
Get detailed uptime and incident statistics:Configuration requirements
Before running any commands, ensure you have a.env file in the same directory with the following configuration:
- Database connection (PostgreSQL)
- Redis connection
- Email settings (for alerts)
.env file on startup.
Next steps
Explore the detailed documentation for each command:- guard command - Start the monitoring process
- add command - Add URLs to monitor
- remove command - Remove URLs from monitoring
- list command - View all monitored URLs
- analysis command - View detailed analytics