ohdear-cli

ohdear-cli copied to clipboard

About Oh Dear CLI

Oh Dear CLI was created by Nuno Maduro, is maintained by Owen Voke, and is an Oh Dear CLI tool written in PHP with Laravel Zero.

Install

Requires PHP 8.0+

Via Composer

composer global require ohdearapp/ohdear-cli

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-cli list

Available commands

Account

• ohdear-cli me
  Display details about the currently authenticated user

Application Health Monitoring

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

Broken Links

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

Certificate Health

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

Checks

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

Cron Job Monitoring

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

DNS Monitoring

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

Uptime

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

Maintenance Windows

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

Mixed Content

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

Performance

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

Sites

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

Status Pages

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

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 & detailed information about the changes. You can also follow the Twitter account for latest announcements or just come say hi!: @enunomaduro

Support the development

Do you like this project? Support it by donating

• PayPal: Donate
• Patreon: Donate

License

Oh Dear CLI is an open-sourced software licensed under the MIT license.