1. CLI
  2. Command reference

CLI

CLI command reference

docs

Open the documentation in your browser.

onlineornot docs

checks

Manage uptime checks.

checks create

Create a new uptime check.

onlineornot checks create <NAME> <URL> [OPTIONS]
Argument Type Required Description
NAME string Yes Name of the check
URL string Yes URL to monitor
Option Type Description
--json boolean Output as JSON

checks list

List all uptime checks.

onlineornot checks list [OPTIONS]
Option Type Description
--json boolean Output as JSON

checks view

View a specific uptime check.

onlineornot checks view <ID> [OPTIONS]
Argument Type Required Description
ID string Yes Check ID
Option Type Description
--json boolean Output as JSON

checks delete

Delete an uptime check.

onlineornot checks delete <ID>
Argument Type Required Description
ID string Yes Check ID

billing

Open billing settings in your browser.

onlineornot billing

login

Authenticate through the browser with OAuth Authorization Code and PKCE.

onlineornot login

setup

Authenticate and create the first uptime check. An interactive run prompts for the values not supplied as options. Existing credentials skip the authentication prompt. In non-interactive environments, --url is required.

onlineornot setup [--provider google|github] [--url https://example.com] [--name Example]
Option Type Description
--provider google or github Open this authentication provider directly
--url string URL for the first uptime check
--name string Optional name for the first uptime check

Without --provider, interactive authentication prompts for Google or GitHub. Non-interactive authentication opens the browser-based provider chooser.

Interrupted and repeated runs reconcile the first check before creating one, so resuming does not create a duplicate.

whoami

Display current user information and verify authentication.

onlineornot whoami