Overview

Check server health, component status, and live metrics from the CLI. Run health, health components, and health watch for a real-time dashboard of circuit breakers and provider status.

Quick install

npm install -g omniroute   # or: npx omniroute
omniroute --version

Subcommands

doctor

Flags:

• --no-liveness
• --host <host>
• --liveness-url <url>

Example:

omniroute doctor

health

Flags:

• -v, --verbose
• --json
• --alerts-only

Example:

omniroute health

health components

List health components and their status

Flags:

• --alerts-only

Example:

omniroute health components

health watch

Live dashboard — refresh every N seconds

Flags:

• --interval <s>

Example:

omniroute health watch

status

Show OmniRoute status dashboard

Flags:

• -v, --verbose

Example:

omniroute status