CLI

Guides and reference in this section.

Getting Started

Install `@observeone/cli`, authenticate with `obs login`, and start managing monitors, API checks, heartbeats, and AI Browser tests from the terminal.

Config-as-Code

Define monitors, heartbeats, alert channels, status pages, and incidents in one `obs.json` file. Version-control your monitoring like application code.

Overview of the obs CLI command reference. Discover resource schemas, then jump to per-resource command pages for monitors, API checks, heartbeats, alert channels, status pages, incidents, and suites.

JSON Schema Reference

The full `obs.json` schema. Every field for monitors, API checks, heartbeats, alert channels, status pages, suites, and incidents in one place.

AI Agent Integration

Run the ObserveOne CLI from Claude Code, Cursor, Copilot, or custom bots with JSON output, exit codes, and headless auth for autonomous agents.

Environment Variables

Configure the `obs` CLI through `OBS_API_KEY`, `OBS_API_URL`, and friends. The path of least resistance for CI pipelines and AI agents.

Protocol Monitors (CLI)

Manage SSL, TCP, UDP, and DB monitors from the obs CLI. Certificate expiry, port reachability, and database checks with the same CRUD surface as url-monitor.

Monitors (CLI)

Manage basic HTTP ping monitors from the obs CLI. Create, list, update, run, pause, mute, and delete URL monitors.

API Checks (CLI)

Manage API health checks from the obs CLI. Custom methods, headers, and assertions, plus runs, pause, mute, and delete.

Heartbeats (CLI)

Manage heartbeat checks for background jobs and cron tasks from the obs CLI. Create, update, pause, mute, reset, and delete.

Alert Channels (CLI)

Manage alert channels for notifications from the obs CLI. Create, list, update, and delete notification destinations.

Status Pages (CLI)

Manage public or private status pages from the obs CLI. CRUD plus monitor attachment, removal, and reordering.

Incidents (CLI)

Manage incidents from the obs CLI. Create, list, update, and delete incident records.

Schedules (CLI)

Manage Autopilot test schedules from the obs CLI, including the chainable bulk stop/resume action for piping schedule IDs from a list or another command.

Autopilot Suites (CLI)

Generate and manage AI-driven Playwright Autopilot suites from the obs CLI. Generation, variables, runs, and headless CI / GitHub App bindings.

API Keys & Teams (CLI)

Manage programmatic API keys and team membership from the obs CLI. Create, rotate, toggle, and revoke keys; list, invite, and manage team members and roles.

API Collections (CLI)

Manage API collections from the obs CLI. Reusable base URL and default headers shared by API checks, with {{KEY}} references resolved server-side.

Projects (CLI)

Manage projects from the obs CLI. Simple CRUD for the containers that group monitors, checks, and environments.