UpMonitor CLI Reference
The UpMonitor CLI is a powerful command-line tool for running instant website audits and integrating monitoring into your development workflow.
Installation
You can run the CLI without installation using npx:
npx @upmonitor/cli check https://example.com
Or install it globally:
npm install -g @upmonitor/cli
Commands
check <url>
Runs a stateless diagnostic audit on a URL.
monitor <command>
Manage continuous monitors.
add <url>: Create a new monitor.list: List all monitors.show <id>: Details + latest result.edit <id>: Update name, interval, regions, etc.rm <id>: Delete a monitor.check <id>: Trigger a manual check.history <id>: View recent results.
incident <command>
Manage active incidents.
list: List open/closed incidents.show <id>: Incident root cause & remediation.ack <id>: Acknowledge an incident.resolve <id>: Manually close an incident.
usage
Show current API quota and monthly usage.
login / register
Authenticate or create an account from the terminal.
Options
| Option | Description |
|---|---|
--checks <list> | Comma-separated list of checks to run (e.g., ssl,dns). |
--ci | Optimizes output for CI/CD environments (minimal colors, plain text). |
--fail-on <level> | Exit with code 1, if a check result matches <level> (warning or failure). |
--format <type> | Output format: pretty (default), json, or csv. |
--region <id> | Run the check from a specific global region, if you are logged in. |
CI/CD Integration
GitHub Actions
Integrate UpMonitor into your deployment pipeline to catch security and performance regressions automatically.
name: Production Health Check
on: [push]
jobs:
audit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run UpMonitor Audit
run: npx @upmonitor/cli check https://upmonitor.io --ci --fail-on failure
GitLab CI
stages:
- post-deploy
health_check:
stage: post-deploy
script:
- npx @upmonitor/cli check https://upmonitor.io --ci --fail-on failure
Exit Codes
0: All checks passed.1: One or more checks failed (based on--fail-on).2: Configuration or network error.