Our CLI tool

Our CLI tool allows you to interact with Oh Dear via the CLI.

Here's what it looks like.

The maintainer of this tool, Owen Voke, has written a series of blogposts on the Oh Dear CLI tool.

Installation

Requires PHP 8.1+

Via composer

composer global require ohdearapp/ohdear-cli

Via Docker

docker run --rm ghcr.io/ohdearapp/ohdear-cli:latest

Via Homebrew

brew install ohdear-cli

If Brew can't find the formula, try running brew update.

Once the Oh Dear CLI is installed, set your API key in the OHDEAR_API_TOKEN environment variable, you can generate one from the API access page.

Usage

ohdear list

Available commands

Account

• ohdear me
  Display details about the currently authenticated user

Application Health Monitoring

• ohdear application-health:show [id]
  Display application health for a specific site

Broken Links

• ohdear broken-link:show [site-id]
  Display broken links for a specific site

Certificate Health

• ohdear certificate-health:show [site-id] [--checks] [--issuers]
  Display certificate health for a specific site (use --checks or --issuers for additional information)

Checks

• ohdear check:disable [id]
  Disable a specific check
• ohdear check:enable [id]
  Enable a specific check
• ohdear check:request-run [id]
  Request a new run for a specific check
• ohdear check:show [site-id]
  Display checks for a specific site

Cron Job Monitoring

• ohdear cron-check:add [site-id] [name] [frequency-or-expression] [--grace-time=5] [--description=] [--timezone=UTC]
  Add a new cron check for a site
• ohdear cron-check:delete [id]
  Delete a cron check
• ohdear cron-check:show [site-id]
  Display the cron checks for a specific site

DNS Monitoring

• ohdear dns-history:list [site-id]
  Display a list of DNS history items and their summary
• ohdear dns-history:show [site-id] [id]
  Display details about a specific DNS history item

Lighthouse SEO Reports

• ohdear lighthouse-report:list [site-id]
  Display a list of Lighthouse reports and their summary
• ohdear lighthouse-report:show [site-id]
  Display details about the latest Lighthouse report
• ohdear lighthouse-report:show [site-id] [id]
  Display details about a specific Lighthouse report

Maintenance Windows

• ohdear maintenance-period:add [site-id] [start-date] [end-date]
  Add a new maintenance period for a site
• ohdear maintenance-period:delete [id]
  Delete a maintenance period
• ohdear maintenance-period:show [id]
  Display maintenance periods for a specific site
• ohdear maintenance-period:start [site-id] [seconds]
  Start a new maintenance period for a site
• ohdear maintenance-period:stop [site-id]
  Stop the currently active maintenance period for a site

Mixed Content

• ohdear mixed-content:show [site-id]
  Display mixed content for a specific site

Performance

• ohdear performance:show [id] [start-date?] [end-date?] [--limit=5] [--timeframe=1h]
  Display performance details for a specific site

Monitors

• ohdear sites:add [url]
  Add a new monitor to Oh Dear
• ohdear sites:list
  Display a list of sites and their current status
• ohdear sites:show [id]
  Display details about a specific site

Status Pages

• ohdear status-pages:list
  Display a list of status pages and their current status
• ohdear status-pages:show [id]
  Display details about a specific status page
• ohdear status-page-updates:add [status-page-id] [title] [text] [--severity=info] [--pinned] [--time=]
  Add a new update for a status page
• ohdear status-page-updates:list [status-page-id]
  Display updates for a status page
• ohdear status-page-updates:delete [id]
  Delete a status page update

Uptime

• ohdear uptime:show [site-id] [start-date?] [end-date?] [--limit=10] [--timeframe=hour]
  Display the uptime for a specific site
• ohdear downtime:show [site-id] [start-date?] [end-date?] [--limit=10]
  Display the downtime for a specific site