The ObserveOne CLI (obs) allows developers and AI Agents to manage URL Monitors, API Checks, Heartbeats, Alert Channels, Status Pages, Incidents, and AI Browser tests directly from the terminal.
Installation#
Install the CLI globally using npm:
npm install -g @observeone/cli
npm install -g @observeone/cli
Authentication#
Before managing resources, you need to authenticate with your ObserveOne account.
Interactive Login#
For human developers, the easiest way is to use the interactive login command:
obs login
obs login
This will open your default web browser and securely complete the OAuth/SSO flow. After authenticating, run obs init to provision your local project workspace.
Note: To switch accounts or refresh a session, use obs login --force. To clear your local credentials entirely, run obs logout.
Headless Agent Login#
If you are configuring an autonomous AI coding agent (like Claude Code or Cursor) or running in a CI/CD pipeline, you can provision an API key headlessly using your account credentials:
export OBS_EMAIL="[email protected]"export OBS_PASSWORD="secure-password"obs login --headless
export OBS_EMAIL="[email protected]"export OBS_PASSWORD="secure-password"obs login --headless
Alternatively, if you already have an API key from the ObserveOne dashboard (Settings > API Keys > Create New Key), you can bypass the login command entirely by exporting it to your environment:
export OBS_API_KEY="your-api-key"
export OBS_API_KEY="your-api-key"
Global Options#
These options can be used with any command:
--api-key <key>: Override the stored API key.--api-url <url>: Override the API base URL.--json: Output results in strict JSON format.--verbose: Enable detailed execution logs.--version: Show the CLI version.
Project Configuration#
To configure project-specific defaults for your current directory, run the initialization command:
obs init
obs init
This creates an obs.json file in the current directory. Run obs apply to sync it with the backend.
Next Steps#
- Learn how to manage infrastructure declaratively in the Config-as-Code Guide.
- Explore the manual CRUD commands in the CLI Reference.