Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/openstatusHQ/cli. OpenStatus CLI www.openstatus.dev
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355'\" t.\" Automatically generated by Pandoc 3.7.0.2.\".TH "" "" "" "".SH OpenStatus CLI.SS CLI interface \- openstatusOpenStatus is a command line interface for managing your monitors andtriggering your synthetics tests.Please report any issues athttps://github.com/openstatusHQ/cli/issues/new..PPThis is OpenStatus Command Line Interface, the OpenStatus.dev CLI..PPUsage:.IP.EX$ openstatus [COMMAND] [COMMAND FLAGS] [ARGUMENTS...].EE.SS \f[CR]monitors\f[R] commandManage your monitors..PPUsage:.IP.EX$ openstatus [GLOBAL FLAGS] monitors [ARGUMENTS...].EE.SS \f[CR]monitors apply\f[R] subcommandCreate or update monitors..RS.PPopenstatus monitors apply [options].RE.PPCreates or updates monitors according to the OpenStatus configurationfile..PPUsage:.IP.EX$ openstatus [GLOBAL FLAGS] monitors apply [COMMAND FLAGS] [ARGUMENTS...].EE.PPThe following flags are supported:.PP.TStab(@);lw(16.0n) lw(30.3n) cw(10.5n) cw(13.2n).T{NameT}@T{DescriptionT}@T{Default valueT}@T{Environment variablesT}_T{\f[CR]\-\-config=\(dq\&...\(dq\f[R] (\f[CR]\-c\f[R])T}@T{The configuration file containing monitor informationT}@T{\f[CR]openstatus.yaml\f[R]T}@T{\f[I]none\f[R]T}T{\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R])T}@T{OpenStatus API Access TokenT}@T{T}@T{\f[CR]OPENSTATUS_API_TOKEN\f[R]T}T{\f[CR]\-\-auto\-accept\f[R] (\f[CR]\-y\f[R])T}@T{Automatically accept the promptT}@T{\f[CR]false\f[R]T}@T{\f[I]none\f[R]T}.TE.SS \f[CR]monitors import\f[R] subcommandImport all your monitors..RS.PPopenstatus monitors import [options].RE.PPImport all your monitors from your workspace to a YAML file; it willalso create a lock file to manage your monitors with `apply'..PPUsage:.IP.EX$ openstatus [GLOBAL FLAGS] monitors import [COMMAND FLAGS] [ARGUMENTS...].EE.PPThe following flags are supported:.PP.TStab(@);lw(20.1n) lw(20.1n) cw(13.2n) cw(16.6n).T{NameT}@T{DescriptionT}@T{Default valueT}@T{Environment variablesT}_T{\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R])T}@T{OpenStatus API Access TokenT}@T{T}@T{\f[CR]OPENSTATUS_API_TOKEN\f[R]T}T{\f[CR]\-\-output=\(dq\&...\(dq\f[R] (\f[CR]\-o\f[R])T}@T{The output file nameT}@T{\f[CR]openstatus.yaml\f[R]T}@T{\f[I]none\f[R]T}.TE.SS \f[CR]monitors info\f[R] subcommandGet a monitor information..RS.PPopenstatus monitors info [MonitorID].RE.PPFetch the monitor information.The monitor information includes details such as name, description,endpoint, method, frequency, locations, active status, public status,timeout, degraded after, and body.The body is truncated to 40 characters..PPUsage:.IP.EX$ openstatus [GLOBAL FLAGS] monitors info [COMMAND FLAGS] [ARGUMENTS...].EE.PPThe following flags are supported:.PP.TStab(@);lw(20.9n) lw(20.9n) cw(10.8n) cw(17.3n).T{NameT}@T{DescriptionT}@T{Default valueT}@T{Environment variablesT}_T{\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R])T}@T{OpenStatus API Access TokenT}@T{T}@T{\f[CR]OPENSTATUS_API_TOKEN\f[R]T}.TE.SS \f[CR]monitors list\f[R] subcommandList all monitors..RS.PPopenstatus monitors list [options].RE.PPList all monitors.The list shows all your monitors attached to your workspace.It displays the ID, name, and URL of each monitor..PPUsage:.IP.EX$ openstatus [GLOBAL FLAGS] monitors list [COMMAND FLAGS] [ARGUMENTS...].EE.PPThe following flags are supported:.PP.TStab(@);lw(18.3n) lw(27.1n) cw(9.5n) cw(15.1n).T{NameT}@T{DescriptionT}@T{Default valueT}@T{Environment variablesT}_T{\f[CR]\-\-all\f[R]T}@T{List all monitors including inactive onesT}@T{\f[CR]false\f[R]T}@T{\f[I]none\f[R]T}T{\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R])T}@T{OpenStatus API Access TokenT}@T{T}@T{\f[CR]OPENSTATUS_API_TOKEN\f[R]T}.TE.SS \f[CR]monitors trigger\f[R] subcommandTrigger a monitor execution..RS.PPopenstatus monitors trigger [MonitorId] [options].RE.PPTrigger a monitor execution on demand.This command allows you to launch your tests on demand..PPUsage:.IP.EX$ openstatus [GLOBAL FLAGS] monitors trigger [COMMAND FLAGS] [ARGUMENTS...].EE.PPThe following flags are supported:.PP.TStab(@);lw(20.9n) lw(20.9n) cw(10.8n) cw(17.3n).T{NameT}@T{DescriptionT}@T{Default valueT}@T{Environment variablesT}_T{\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R])T}@T{OpenStatus API Access TokenT}@T{T}@T{\f[CR]OPENSTATUS_API_TOKEN\f[R]T}.TE.SS \f[CR]run\f[R] command (aliases: \f[CR]r\f[R])Run your synthetics tests..RS.PPopenstatus run [options].RE.PPRun the synthetic tests defined in the config.openstatus.yaml..PPUsage:.IP.EX$ openstatus [GLOBAL FLAGS] run [COMMAND FLAGS] [ARGUMENTS...].EE.PPThe following flags are supported:.PP.TStab(@);lw(18.8n) lw(18.8n) cw(16.9n) cw(15.6n).T{NameT}@T{DescriptionT}@T{Default valueT}@T{Environment variablesT}_T{\f[CR]\-\-config=\(dq\&...\(dq\f[R]T}@T{The configuration fileT}@T{\f[CR]config.openstatus.yaml\f[R]T}@T{\f[I]none\f[R]T}T{\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R])T}@T{OpenStatus API Access TokenT}@T{T}@T{\f[CR]OPENSTATUS_API_TOKEN\f[R]T}.TE.SS \f[CR]whoami\f[R] command (aliases: \f[CR]w\f[R])Get your workspace information..RS.PPopenstatus whoami [options].RE.PPGet your current workspace information, display the workspace name,slug, and plan..PPUsage:.IP.EX$ openstatus [GLOBAL FLAGS] whoami [COMMAND FLAGS] [ARGUMENTS...].EE.PPThe following flags are supported:.PP.TStab(@);lw(20.9n) lw(20.9n) cw(10.8n) cw(17.3n).T{NameT}@T{DescriptionT}@T{Default valueT}@T{Environment variablesT}_T{\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R])T}@T{OpenStatus API Access TokenT}@T{T}@T{\f[CR]OPENSTATUS_API_TOKEN\f[R]T}.TE