Getting Started

You can use the OpenStatus CLI to manage and run your monitors. The CLI is a powerful tool that allows you to interact with OpenStatus from your terminal.

Installation

You can install the OpenStatus CLI using brew.

Windows

iwr instl.sh/openstatushq/cli/windows | iex

macOS

brew install openstatusHQ/cli/openstatus --cask

or

curl -sSL instl.sh/openstatushq/cli/macos | bash

Linux

curl -sSL instl.sh/openstatushq/cli/linux | bash

Then you can run the following command to verify the installation.

openstatus --help

Usage

You need to get an API token to use the CLI. You can get an API key by signing up on the OpenStatus website.

Settings → API Token → Create API token

You can set the API token using the following command.

export OPENSTATUS_API_TOKEN=your-api-token

or you can set the --access-token option in the CLI command.

openstatus [COMMAND] --access-token your-api-token