diff --git a/docs/openstatus-docs.md b/docs/openstatus-docs.md index caf38cb..912f49e 100644 --- a/docs/openstatus-docs.md +++ b/docs/openstatus-docs.md @@ -2,7 +2,7 @@ ## CLI interface - openstatus -OpenStatus CLI lets you manage your status pages and uptime monitors from the command line. Report and track incidents, define monitors as code, and run on-demand checks. Get started: openstatus login Save your API token openstatus status-report create Report an incident openstatus status-report list View active incidents openstatus monitors apply Sync monitors from config openstatus monitors list List your monitors openstatus run Run synthetic tests https://docs.openstatus.dev | https://github.com/openstatusHQ/cli/issues/new. +OpenStatus CLI lets you manage your status pages and uptime monitors from the command line. Report and track incidents, define monitors as code, and run on-demand checks. Get started: openstatus login Save your API token openstatus status-report create Report an incident openstatus status-report list View active incidents openstatus maintenance create Schedule a maintenance window openstatus maintenance list View maintenance windows openstatus monitors apply Sync monitors from config openstatus monitors list List your monitors openstatus run Run synthetic tests https://docs.openstatus.dev | https://github.com/openstatusHQ/cli/issues/new. Manage status pages, monitors, and incidents from the terminal. @@ -127,8 +127,9 @@ Get a monitor information. > openstatus monitors info > openstatus monitors info 12345 +> openstatus monitors info 12345 --time-range 7d -Fetch 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. +Fetch the monitor information including configuration, live status per region, and summary metrics. Usage: @@ -138,9 +139,10 @@ $ openstatus [GLOBAL FLAGS] monitors info [COMMAND FLAGS] [ARGUMENTS...] The following flags are supported: -| Name | Description | Default value | Environment variables | -|-----------------------------|-----------------------------|:-------------:|:----------------------:| -| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | +| Name | Description | Default value | Environment variables | +|-----------------------------|----------------------------------------------|:-------------:|:----------------------:| +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | +| `--time-range="…"` | Time range for summary metrics (1d, 7d, 14d) | `1d` | *none* | ### `monitors list` subcommand @@ -322,6 +324,124 @@ The following flags are supported: | `--date="…"` | Date for the update (RFC 3339 format, defaults to now) | | *none* | | `--notify` | Notify subscribers about this update | `false` | *none* | +### `maintenance` command (aliases: `mt`) + +Manage maintenance windows. + +Usage: + +```bash +$ openstatus [GLOBAL FLAGS] maintenance [ARGUMENTS...] +``` + +### `maintenance list` subcommand + +List all maintenance windows. + +> openstatus maintenance list +> openstatus maintenance list --page-id abc --limit 10 + +Usage: + +```bash +$ openstatus [GLOBAL FLAGS] maintenance list [COMMAND FLAGS] [ARGUMENTS...] +``` + +The following flags are supported: + +| Name | Description | Default value | Environment variables | +|-----------------------------|--------------------------------------------------|:-------------:|:----------------------:| +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | +| `--page-id="…"` | Filter by status page ID | | *none* | +| `--limit="…"` | Maximum number of maintenances to return (1-100) | `0` | *none* | + +### `maintenance info` subcommand + +Get maintenance window details. + +> openstatus maintenance info +> openstatus maintenance info 12345 + +Usage: + +```bash +$ openstatus [GLOBAL FLAGS] maintenance info [COMMAND FLAGS] [ARGUMENTS...] +``` + +The following flags are supported: + +| Name | Description | Default value | Environment variables | +|-----------------------------|-----------------------------|:-------------:|:----------------------:| +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | + +### `maintenance create` subcommand + +Create a maintenance window. + +> openstatus maintenance create --title "DB Migration" --message "Upgrading database" --from 2026-04-01T10:00:00Z --to 2026-04-01T12:00:00Z --page-id 123 + +Usage: + +```bash +$ openstatus [GLOBAL FLAGS] maintenance create [COMMAND FLAGS] [ARGUMENTS...] +``` + +The following flags are supported: + +| Name | Description | Default value | Environment variables | +|-----------------------------|--------------------------------------------------------|:-------------:|:----------------------:| +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | +| `--title="…"` | Title of the maintenance | | *none* | +| `--message="…"` | Message describing the maintenance | | *none* | +| `--from="…"` | Start time of the maintenance window (RFC 3339 format) | | *none* | +| `--to="…"` | End time of the maintenance window (RFC 3339 format) | | *none* | +| `--page-id="…"` | Status page ID to associate with this maintenance | | *none* | +| `--component-ids="…"` | Comma-separated page component IDs | | *none* | +| `--notify` | Notify subscribers about this maintenance | `false` | *none* | + +### `maintenance update` subcommand + +Update a maintenance window. + +> openstatus maintenance update [--title "New title"] [--message "New message"] [--from ...] [--to ...] + +Usage: + +```bash +$ openstatus [GLOBAL FLAGS] maintenance update [COMMAND FLAGS] [ARGUMENTS...] +``` + +The following flags are supported: + +| Name | Description | Default value | Environment variables | +|-----------------------------|-------------------------------------------------------------|:-------------:|:----------------------:| +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | +| `--title="…"` | New title for the maintenance | | *none* | +| `--message="…"` | New message for the maintenance | | *none* | +| `--from="…"` | New start time (RFC 3339 format) | | *none* | +| `--to="…"` | New end time (RFC 3339 format) | | *none* | +| `--component-ids="…"` | Comma-separated page component IDs (replaces existing list) | | *none* | + +### `maintenance delete` subcommand + +Delete a maintenance window. + +> openstatus maintenance delete +> openstatus maintenance delete 12345 -y + +Usage: + +```bash +$ openstatus [GLOBAL FLAGS] maintenance delete [COMMAND FLAGS] [ARGUMENTS...] +``` + +The following flags are supported: + +| Name | Description | Default value | Environment variables | +|-----------------------------|---------------------------------|:-------------:|:----------------------:| +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | +| `--auto-accept` (`-y`) | Automatically accept the prompt | `false` | *none* | + ### `status-page` command (aliases: `sp`) Manage status pages. diff --git a/docs/openstatus.1 b/docs/openstatus.1 index e5e0671..995903f 100644 --- a/docs/openstatus.1 +++ b/docs/openstatus.1 @@ -1,22 +1,83 @@ '\" t -.\" Automatically generated by Pandoc 3.7.0.2 +.\" Automatically generated by Pandoc 3.9.0.2 .\" .TH "" "" "" "" .SH OpenStatus CLI .SS CLI interface \- openstatus -OpenStatus is a command line interface for managing your monitors and -triggering your synthetics tests. -Please report any issues at +OpenStatus CLI lets you manage your status pages and uptime monitors +from the command line. +Report and track incidents, define monitors as code, and run on\-demand +checks. +Get started: openstatus login Save your API token openstatus +status\-report create Report an incident openstatus status\-report list +View active incidents openstatus maintenance create Schedule a +maintenance window openstatus maintenance list View maintenance windows +openstatus monitors apply Sync monitors from config openstatus monitors +list List your monitors openstatus run Run synthetic tests +https://docs.openstatus.dev | https://github.com/openstatusHQ/cli/issues/new. .PP -This is OpenStatus Command Line Interface, the OpenStatus.dev CLI. +Manage status pages, monitors, and incidents from the terminal. .PP Usage: .IP .EX -$ openstatus [COMMAND] [COMMAND FLAGS] [ARGUMENTS...] +$ openstatus [GLOBAL FLAGS] [COMMAND] [COMMAND FLAGS] [ARGUMENTS...] .EE -.SS \f[CR]monitors\f[R] command +.PP +Global flags: +.PP +.TS +tab(@); +lw(15.2n) lw(22.8n) cw(12.7n) cw(19.4n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-json\f[R] +T}@T{ +Output results as JSON +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-no\-color\f[R] +T}@T{ +Disable colored output +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-quiet\f[R] (\f[CR]\-q\f[R]) +T}@T{ +Suppress non\-error output +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-debug\f[R] +T}@T{ +Enable debug output +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]monitors\f[R] command (aliases: \f[CR]m\f[R]) Manage your monitors. .PP Usage: @@ -28,11 +89,14 @@ $ openstatus [GLOBAL FLAGS] monitors [ARGUMENTS...] Create or update monitors. .RS .PP -openstatus monitors apply [options] +openstatus monitors apply openstatus monitors apply \(enconfig +custom.yaml \-y openstatus monitors apply \(endry\-run .RE .PP Creates or updates monitors according to the OpenStatus configuration file. +Compares your openstatus.yaml with the current state and applies +changes. .PP Usage: .IP @@ -81,12 +145,126 @@ T}@T{ T}@T{ \f[I]none\f[R] T} +T{ +\f[CR]\-\-dry\-run\f[R] (\f[CR]\-n\f[R]) +T}@T{ +Show what would be changed without applying +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]monitors create\f[R] subcommand +Create monitors. +.RS +.PP +openstatus monitors create openstatus monitors create \(enconfig +custom.yaml \-y +.RE +.PP +Create the monitors defined in the openstatus.yaml file. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] monitors create [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(16.0n) lw(30.3n) cw(10.5n) cw(13.2n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-config=\(dq\&...\(dq\f[R] (\f[CR]\-c\f[R]) +T}@T{ +The configuration file containing monitor information +T}@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 Token +T}@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 prompt +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]monitors delete\f[R] subcommand +Delete a monitor. +.RS +.PP +openstatus monitors delete openstatus monitors delete 12345 \-y +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] monitors delete [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(20.1n) lw(22.9n) cw(10.4n) cw(16.6n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@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 prompt +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} .TE .SS \f[CR]monitors import\f[R] subcommand Import all your monitors. .RS .PP -openstatus monitors import [options] +openstatus monitors import openstatus monitors import \(enoutput +monitors.yaml .RE .PP Import all your monitors from your workspace to a YAML file; it will @@ -135,14 +313,12 @@ T} Get a monitor information. .RS .PP -openstatus monitors info [MonitorID] +openstatus monitors info openstatus monitors info 12345 openstatus +monitors info 12345 \(entime\-range 7d .RE .PP -Fetch 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. +Fetch the monitor information including configuration, live status per +region, and summary metrics. .PP Usage: .IP @@ -154,7 +330,7 @@ The following flags are supported: .PP .TS tab(@); -lw(20.9n) lw(20.9n) cw(10.8n) cw(17.3n). +lw(17.8n) lw(28.2n) cw(9.2n) cw(14.7n). T{ Name T}@T{ @@ -173,17 +349,26 @@ T}@T{ T}@T{ \f[CR]OPENSTATUS_API_TOKEN\f[R] T} +T{ +\f[CR]\-\-time\-range=\(dq\&...\(dq\f[R] +T}@T{ +Time range for summary metrics (1d, 7d, 14d) +T}@T{ +\f[CR]1d\f[R] +T}@T{ +\f[I]none\f[R] +T} .TE .SS \f[CR]monitors list\f[R] subcommand List all monitors. .RS .PP -openstatus monitors list [options] +openstatus monitors list openstatus monitors list \(enall .RE .PP List all monitors. The list shows all your monitors attached to your workspace. -It displays the ID, name, and URL of each monitor. +It displays the ID, name, URL, and kind of each monitor. .PP Usage: .IP @@ -228,7 +413,7 @@ T} Trigger a monitor execution. .RS .PP -openstatus monitors trigger [MonitorId] [options] +openstatus monitors trigger openstatus monitors trigger 12345 .RE .PP Trigger a monitor execution on demand. @@ -264,26 +449,33 @@ 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. +.SS \f[CR]status\-report\f[R] command (aliases: \f[CR]sr\f[R]) +Manage status reports. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] status\-report [ARGUMENTS...] +.EE +.SS \f[CR]status\-report list\f[R] subcommand +List all status reports. .RS .PP -openstatus run [options] +openstatus status\-report list openstatus status\-report list \(enstatus +investigating \(enlimit 10 .RE .PP -Run the synthetic tests defined in the config.openstatus.yaml. -.PP Usage: .IP .EX -$ openstatus [GLOBAL FLAGS] run [COMMAND FLAGS] [ARGUMENTS...] +$ openstatus [GLOBAL FLAGS] status\-report list [COMMAND FLAGS] [ARGUMENTS...] .EE .PP The following flags are supported: .PP .TS tab(@); -lw(18.8n) lw(18.8n) cw(16.9n) cw(15.6n). +lw(14.9n) lw(35.0n) cw(7.7n) cw(12.4n). T{ Name T}@T{ @@ -295,14 +487,59 @@ Environment variables T} _ T{ -\f[CR]\-\-config=\(dq\&...\(dq\f[R] +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) T}@T{ -The configuration file +OpenStatus API Access Token T}@T{ -\f[CR]config.openstatus.yaml\f[R] +T}@T{ +\f[CR]OPENSTATUS_API_TOKEN\f[R] +T} +T{ +\f[CR]\-\-status=\(dq\&...\(dq\f[R] +T}@T{ +Filter by status (investigating, identified, monitoring, resolved) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-limit=\(dq\&...\(dq\f[R] +T}@T{ +Maximum number of reports to return (1\-100) +T}@T{ +\f[CR]0\f[R] T}@T{ \f[I]none\f[R] T} +.TE +.SS \f[CR]status\-report info\f[R] subcommand +Get status report details. +.RS +.PP +openstatus status\-report info openstatus status\-report info 12345 +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] status\-report info [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(20.9n) lw(20.9n) cw(10.8n) cw(17.3n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ T{ \f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) T}@T{ @@ -312,27 +549,26 @@ 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. +.SS \f[CR]status\-report create\f[R] subcommand +Create a status report. .RS .PP -openstatus whoami [options] +openstatus status\-report create \(entitle \(lqAPI Degradation\(rq +\(enstatus investigating \(enmessage \(lqInvestigating increased +latency\(rq \(enpage\-id 123 .RE .PP -Get your current workspace information, display the workspace name, -slug, and plan. -.PP Usage: .IP .EX -$ openstatus [GLOBAL FLAGS] whoami [COMMAND FLAGS] [ARGUMENTS...] +$ openstatus [GLOBAL FLAGS] status\-report create [COMMAND FLAGS] [ARGUMENTS...] .EE .PP The following flags are supported: .PP .TS tab(@); -lw(20.9n) lw(20.9n) cw(10.8n) cw(17.3n). +lw(15.1n) lw(34.5n) cw(7.8n) cw(12.5n). T{ Name T}@T{ @@ -351,4 +587,762 @@ T}@T{ T}@T{ \f[CR]OPENSTATUS_API_TOKEN\f[R] T} +T{ +\f[CR]\-\-title=\(dq\&...\(dq\f[R] +T}@T{ +Title of the status report +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-status=\(dq\&...\(dq\f[R] +T}@T{ +Initial status (investigating, identified, monitoring, resolved) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-message=\(dq\&...\(dq\f[R] +T}@T{ +Initial message describing the incident +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-page\-id=\(dq\&...\(dq\f[R] +T}@T{ +Status page ID to associate with this report +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-component\-ids=\(dq\&...\(dq\f[R] +T}@T{ +Comma\-separated page component IDs +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-notify\f[R] +T}@T{ +Notify subscribers about this status report +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-date=\(dq\&...\(dq\f[R] +T}@T{ +Date when the event occurred (RFC 3339 format, defaults to now) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} .TE +.SS \f[CR]status\-report update\f[R] subcommand +Update status report metadata. +.RS +.PP +openstatus status\-report update [\(entitle \(lqNew title\(rq] +[\(encomponent\-ids id1,id2] +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] status\-report update [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(15.7n) lw(33.1n) cw(8.1n) cw(13.0n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@T{ +T}@T{ +\f[CR]OPENSTATUS_API_TOKEN\f[R] +T} +T{ +\f[CR]\-\-title=\(dq\&...\(dq\f[R] +T}@T{ +New title for the report +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-component\-ids=\(dq\&...\(dq\f[R] +T}@T{ +Comma\-separated page component IDs (replaces existing list) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]status\-report delete\f[R] subcommand +Delete a status report. +.RS +.PP +openstatus status\-report delete openstatus status\-report delete 12345 +\-y +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] status\-report delete [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(20.1n) lw(22.9n) cw(10.4n) cw(16.6n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@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 prompt +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]status\-report add\-update\f[R] subcommand +Add an update to a status report. +.RS +.PP +openstatus status\-report add\-update \(enstatus resolved \(enmessage +\(lqIssue has been resolved\(rq +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] status\-report add\-update [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(15.6n) lw(33.4n) cw(8.1n) cw(12.9n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@T{ +T}@T{ +\f[CR]OPENSTATUS_API_TOKEN\f[R] +T} +T{ +\f[CR]\-\-status=\(dq\&...\(dq\f[R] +T}@T{ +New status (investigating, identified, monitoring, resolved) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-message=\(dq\&...\(dq\f[R] +T}@T{ +Message describing what changed +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-date=\(dq\&...\(dq\f[R] +T}@T{ +Date for the update (RFC 3339 format, defaults to now) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-notify\f[R] +T}@T{ +Notify subscribers about this update +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]maintenance\f[R] command (aliases: \f[CR]mt\f[R]) +Manage maintenance windows. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] maintenance [ARGUMENTS...] +.EE +.SS \f[CR]maintenance list\f[R] subcommand +List all maintenance windows. +.RS +.PP +openstatus maintenance list openstatus maintenance list \(enpage\-id abc +\(enlimit 10 +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] maintenance list [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(17.2n) lw(29.7n) cw(8.9n) cw(14.2n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@T{ +T}@T{ +\f[CR]OPENSTATUS_API_TOKEN\f[R] +T} +T{ +\f[CR]\-\-page\-id=\(dq\&...\(dq\f[R] +T}@T{ +Filter by status page ID +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-limit=\(dq\&...\(dq\f[R] +T}@T{ +Maximum number of maintenances to return (1\-100) +T}@T{ +\f[CR]0\f[R] +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]maintenance info\f[R] subcommand +Get maintenance window details. +.RS +.PP +openstatus maintenance info openstatus maintenance info 12345 +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] maintenance info [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(20.9n) lw(20.9n) cw(10.8n) cw(17.3n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@T{ +T}@T{ +\f[CR]OPENSTATUS_API_TOKEN\f[R] +T} +.TE +.SS \f[CR]maintenance create\f[R] subcommand +Create a maintenance window. +.RS +.PP +openstatus maintenance create \(entitle \(lqDB Migration\(rq \(enmessage +\(lqUpgrading database\(rq \(enfrom 2026\-04\-01T10:00:00Z \(ento +2026\-04\-01T12:00:00Z \(enpage\-id 123 +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] maintenance create [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(16.4n) lw(31.6n) cw(8.5n) cw(13.5n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@T{ +T}@T{ +\f[CR]OPENSTATUS_API_TOKEN\f[R] +T} +T{ +\f[CR]\-\-title=\(dq\&...\(dq\f[R] +T}@T{ +Title of the maintenance +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-message=\(dq\&...\(dq\f[R] +T}@T{ +Message describing the maintenance +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-from=\(dq\&...\(dq\f[R] +T}@T{ +Start time of the maintenance window (RFC 3339 format) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-to=\(dq\&...\(dq\f[R] +T}@T{ +End time of the maintenance window (RFC 3339 format) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-page\-id=\(dq\&...\(dq\f[R] +T}@T{ +Status page ID to associate with this maintenance +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-component\-ids=\(dq\&...\(dq\f[R] +T}@T{ +Comma\-separated page component IDs +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-notify\f[R] +T}@T{ +Notify subscribers about this maintenance +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]maintenance update\f[R] subcommand +Update a maintenance window. +.RS +.PP +openstatus maintenance update [\(entitle \(lqNew title\(rq] +[\(enmessage \(lqNew message\(rq] [\(enfrom \&...] +[\(ento \&...] +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] maintenance update [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(15.7n) lw(33.1n) cw(8.1n) cw(13.0n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@T{ +T}@T{ +\f[CR]OPENSTATUS_API_TOKEN\f[R] +T} +T{ +\f[CR]\-\-title=\(dq\&...\(dq\f[R] +T}@T{ +New title for the maintenance +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-message=\(dq\&...\(dq\f[R] +T}@T{ +New message for the maintenance +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-from=\(dq\&...\(dq\f[R] +T}@T{ +New start time (RFC 3339 format) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-to=\(dq\&...\(dq\f[R] +T}@T{ +New end time (RFC 3339 format) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +T{ +\f[CR]\-\-component\-ids=\(dq\&...\(dq\f[R] +T}@T{ +Comma\-separated page component IDs (replaces existing list) +T}@T{ +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]maintenance delete\f[R] subcommand +Delete a maintenance window. +.RS +.PP +openstatus maintenance delete openstatus maintenance delete 12345 \-y +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] maintenance delete [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(20.1n) lw(22.9n) cw(10.4n) cw(16.6n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@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 prompt +T}@T{ +\f[CR]false\f[R] +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]status\-page\f[R] command (aliases: \f[CR]sp\f[R]) +Manage status pages. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] status\-page [ARGUMENTS...] +.EE +.SS \f[CR]status\-page list\f[R] subcommand +List all status pages. +.RS +.PP +openstatus status\-page list openstatus status\-page list \(enlimit 10 +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] status\-page list [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(18.3n) lw(27.1n) cw(9.5n) cw(15.1n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@T{ +T}@T{ +\f[CR]OPENSTATUS_API_TOKEN\f[R] +T} +T{ +\f[CR]\-\-limit=\(dq\&...\(dq\f[R] +T}@T{ +Maximum number of pages to return (1\-100) +T}@T{ +\f[CR]0\f[R] +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]status\-page info\f[R] subcommand +Get status page details. +.RS +.PP +openstatus status\-page info openstatus status\-page info 12345 +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] status\-page info [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(20.9n) lw(20.9n) cw(10.8n) cw(17.3n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@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 uptime tests. +.RS +.PP +openstatus run openstatus run \(enconfig custom\-config.yaml +.RE +.PP +Run the uptime tests defined in the config.openstatus.yaml. +The config file should be in the following format: tests: ids: \- +monitor\-id\-1 \- monitor\-id\-2. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] run [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(18.8n) lw(18.8n) cw(16.9n) cw(15.6n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-config=\(dq\&...\(dq\f[R] +T}@T{ +The configuration file +T}@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 Token +T}@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 +.PP +openstatus whoami +.RE +.PP +Get your current workspace information. +Displays the workspace name, slug, and plan. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] whoami [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: +.PP +.TS +tab(@); +lw(20.9n) lw(20.9n) cw(10.8n) cw(17.3n). +T{ +Name +T}@T{ +Description +T}@T{ +Default value +T}@T{ +Environment variables +T} +_ +T{ +\f[CR]\-\-access\-token=\(dq\&...\(dq\f[R] (\f[CR]\-t\f[R]) +T}@T{ +OpenStatus API Access Token +T}@T{ +T}@T{ +\f[CR]OPENSTATUS_API_TOKEN\f[R] +T} +.TE +.SS \f[CR]login\f[R] command +Save your API token. +.RS +.PP +openstatus login +.RE +.PP +Saves your OpenStatus API token for use in subsequent commands. +Get your API token from the OpenStatus dashboard. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] login [ARGUMENTS...] +.EE +.SS \f[CR]logout\f[R] command +Remove saved API token. +.RS +.PP +openstatus logout +.RE +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] logout [ARGUMENTS...] +.EE