.\" Automatically generated by Pandoc 3.7.0.2
.\"
.TH "" "" "" ""
.SH OpenStatus CLI
.SH NAME
openstatus \- This is OpenStatus Command Line Interface, the
OpenStatus.dev CLI
.SH SYNOPSIS
openstatus
.SH DESCRIPTION
OpenStatus is a command line interface for managing your monitors and
triggering your synthetics tests.
.PP
Please report any issues at
https://github.com/openstatusHQ/cli/issues/new
.PP
\f[B]Usage\f[R]:
.IP
.EX
openstatus [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...]
.EE
.SH COMMANDS
.SS monitors
Manage your monitors
.SS create
Create monitors (beta)
.RS
.PP
openstatus monitors create [options]
.RE
.PP
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
.PP
\f[B]\(enauto\-accept, \-y\f[R]: Automatically accept the prompt
.PP
\f[B]\(enconfig\f[R]=\(lq\(lq: The configuration file containing monitor
information (default: openstatus.yaml)
.SS delete
Delete a monitor
.RS
.PP
openstatus monitors delete [MonitorID] [options]
.RE
.PP
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
.PP
\f[B]\(enauto\-accept, \-y\f[R]: Automatically accept the prompt
.SS export
Export all your monitors
.RS
.PP
openstatus monitor export [options]
.RE
.PP
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
.PP
\f[B]\(enoutput, \-o\f[R]=\(lq\(lq: The output file name (default:
openstatus.yaml)
.SS info
Get a monitor information
.RS
.PP
openstatus monitor info [MonitorID]
.RE
.PP
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
.SS list
List all monitors
.RS
.PP
openstatus monitors list [options]
.RE
.PP
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
.PP
\f[B]\(enall\f[R]: List all monitors including inactive ones
.SS trigger
Trigger a monitor execution
.RS
.PP
openstatus monitors trigger [MonitorId] [options]
.RE
.PP
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
.SS run, r
Run your synthetics tests
.RS
.PP
openstatus run [options]
.RE
.PP
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
.PP
\f[B]\(enconfig\f[R]=\(lq\(lq: The configuration file (default:
config.openstatus.yaml)
.SS whoami, w
Get your workspace information
.RS
.PP
openstatus whoami [options]
.RE
.PP
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token