CLI

Manage monitors, status pages, and incidents from your terminal — interactive for humans, scriptable for agents, and YAML-managed for monitoring as code.

The openstatus CLI is the terminal interface to your workspace. It works for both humans (interactive wizards, colors, spinners) and agents (--json, deterministic flags, structured errors) — and it lets you keep your monitor configuration as YAML in your repo.

Quickstart

brew install openstatusHQ/cli/openstatus --cask
openstatus login
openstatus whoami
openstatus monitors apply

Set OPENSTATUS_API_TOKEN to skip the login flow in CI.

What you can do

• Manage monitors, status pages, status reports, and maintenance windows.
• Sync a YAML config with openstatus monitors apply — monitoring as code, no HCL required.
• Bootstrap a Terraform configuration from your workspace with openstatus terraform generate.
• Pipe --json output into jq, agents, or your own scripts.

GitHub Action

Run the CLI from a workflow with the published GitHub Action — drop it into your release pipeline to apply monitor config changes, trigger synthetic checks on deploy, or fail a deploy when a probe regresses.

- uses: openstatusHQ/cli-action@v1
  with:
    api-token: ${{ secrets.OPENSTATUS_API_TOKEN }}
    args: monitors apply

AI skills

Openstatus skills are agent-ready bundles that wrap the CLI for terminal-shaped AI workflows like Claude Code. Install once, then let your agent draft incidents, schedule maintenance, and post status updates on your behalf.

npx skills add openstatushq/skills

You get incident communication templates, maintenance announcement drafts, periodic status reports, and shared status-page context so every skill speaks in your voice.

Auth & audit

Authenticate with openstatus login (browser flow) or OPENSTATUS_API_TOKEN (CI). The token is the same one the API, Terraform provider, and MCP server share — generate it from Settings → API Tokens.

Every mutation lands in the audit log under actor_type = 'cli', so you can trace any change back to a key, a user, and a transport.

Other surfaces

• Want chat-shaped AI access from Claude or ChatGPT? See the MCP server.
• Already managing infrastructure in HCL? Use the Terraform provider.
• Building an in-app integration? Call the API directly.

Reference

Full command list and flags in the CLI reference.