cli
[READ-ONLY] Mirror of https://github.com/openstatusHQ/cli. OpenStatus CLI www.openstatus.dev
cli cli-app synthetic-monitoring
Star
Fork
Watch
cli openstatus-docs.md
1.7 kB · 91 lines
Markdown
at export-cmd

CLI #

NAME #

openstatus - This is OpenStatus Command Line Interface

SYNOPSIS #

openstatus

DESCRIPTION #

OpenStatus is a command line interface for managing your monitors and triggering your synthetics tests.

Please report any issues at https://github.com/openstatusHQ/cli/issues/new

Usage:

openstatus [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...]

COMMANDS #

monitors #

Manage your monitors

create #

Create monitors (beta)

openstatus monitors create [options]

--access-token, -t="": OpenStatus API Access Token

--auto-accept, -y: Automatically accept the prompt

--config="": The configuration file containing monitor information (default: openstatus.yaml)

delete #

Delete a monitor

openstatus monitors delete [MonitorID] [options]

--access-token, -t="": OpenStatus API Access Token

--auto-accept, -y: Automatically accept the prompt

info #

Get monitor information

--access-token, -t="": OpenStatus API Access Token

list #

List all monitors

openstatus monitors list [options]

--access-token, -t="": OpenStatus API Access Token

--all: List all monitors including inactive ones

trigger #

Trigger a monitor test

openstatus monitors trigger [MonitorId] [options]

--access-token, -t="": OpenStatus API Access Token

run, r #

Run your synthetics tests

openstatus run[options]

--access-token, -t="": OpenStatus API Access Token

--config="": The configuration file (default: config.openstatus.yaml)

whoami, w #

Get your current workspace information

openstatus whoami [options]

--access-token, -t="": OpenStatus API Access Token