Skip to content

Get Started with openstatus CLI

openstatus CLI

Install the OpenStatus CLI to set up your monitors straight in your code.

Terminal window
brew install openstatusHQ/cli/openstatus --cask

or

Terminal window
curl -sSL instl.sh/openstatushq/cli/macos | bash
Terminal window
curl -sSL instl.sh/openstatushq/cli/linux | bash
Terminal window
iwr instl.sh/openstatushq/cli/windows | iex

Create an API key in your workspace settings.

Terminal window
export OPENSTATUS_API_TOKEN=<your-api-token>

Import monitors from your workspace to a YAML file.

Terminal window
openstatus monitors import

Add, remove, or update monitors from a YAML file and apply your changes.

Terminal window
openstatus monitors apply