ohdearapp / ohdear-cli
A standalone CLI tool for Oh Dear monitoring.
Fund package maintenance!
owenvoke
Installs: 1 239
Dependents: 0
Suggesters: 0
Security: 0
Stars: 138
Watchers: 2
Forks: 3
Open Issues: 0
Type:project
pkg:composer/ohdearapp/ohdear-cli
Requires
- php: ^8.4
Requires (Dev)
- illuminate/http: ^12.17
- larastan/larastan: ^3.0
- laravel-zero/framework: ^12.0.2
- laravel/pint: ^1.25.1
- mockery/mockery: ^1.6.12
- pestphp/pest: ^3.8.4|^4.1.2
- pestphp/pest-plugin-arch: ^3.0|^4.0
- phpstan/extension-installer: ^1.4
- phpstan/phpstan-deprecation-rules: ^2.0
- phpstan/phpstan-phpunit: ^2.0
- spatie/laravel-openapi-cli: ^1.0.2
README
About Oh Dear CLI
Oh Dear CLI is a command line tool to manage Oh Dear website monitoring. Built with Laravel Zero, it auto-generates commands from the Oh Dear OpenAPI spec so every API endpoint is available as a CLI command.
Install
Requires PHP 8.4+
Via Composer
composer global require ohdearapp/ohdear-cli
Ensure Composer's global bin directory is in your PATH:
composer global config bin-dir --absolute
Authentication
First, log in with your Oh Dear API token. You can generate one at ohdear.app/user-settings/api.
ohdear login
You'll be prompted for your API token. The token is stored in ~/.ohdear/config.json.
To log out:
ohdear logout
Usage
List all available commands:
ohdear list
Monitors
# List all monitors ohdear list-monitors # Get a specific monitor ohdear get-monitor --monitor-id=123 # Add a new monitor ohdear create-monitor --field url="https://example.com" --field team_id=1 # Delete a monitor ohdear delete-monitor --monitor-id=123
Uptime and downtime
ohdear get-uptime --monitor-id=123 ohdear get-downtime --monitor-id=123
Broken links and mixed content
ohdear list-broken-links --monitor-id=123 ohdear list-mixed-content --monitor-id=123
Certificate health
ohdear get-certificate-health --monitor-id=123
Maintenance periods
ohdear start-maintenance --monitor-id=123 ohdear stop-maintenance --monitor-id=123 ohdear list-maintenance-periods --monitor-id=123
Status pages
ohdear list-status-pages ohdear get-status-page --status-page-id=123 ohdear create-status-page-update --status-page-id=123 --field title="Investigating" --field text="Looking into it."
Cron checks
ohdear list-cron-checks --monitor-id=123
ohdear create-cron-check --monitor-id=123 --field name="Daily Backup" --field frequency_in_minutes=1440
Lighthouse reports
ohdear get-latest-lighthouse-report --monitor-id=123 ohdear list-lighthouse-reports --monitor-id=123
Other commands
ohdear get-me # Display authenticated user info ohdear get-dns-history # DNS history for a monitor ohdear list-application-health-checks # Application health checks ohdear list-tags # List all tags ohdear clear-cache # Clear cached OpenAPI spec
All commands output JSON. Run ohdear <command> --help for full parameter details.
AI Skill
Install the Oh Dear skill for AI coding assistants:
ohdear install-skill
Contributing
Thank you for considering contributing to Oh Dear CLI. All contributions are welcome via pull requests.
You can have a look at the CHANGELOG for constant updates and detailed information about the changes.
License
Oh Dear CLI is an open-sourced software licensed under the MIT license.
