Skip to content

Commit c3c647d

Browse files
thibaultleouaythibaultleouay
committed
chore: update docs
1 parent 6a96100 commit c3c647d

File tree

2 files changed

+1156
-42
lines changed

2 files changed

+1156
-42
lines changed

‎docs/openstatus-docs.md‎

Lines changed: 125 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## CLI interface - openstatus
44

5-
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.
5+
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.
66

77
Manage status pages, monitors, and incidents from the terminal.
88

@@ -127,8 +127,9 @@ Get a monitor information.
127127

128128
> openstatus monitors info <MonitorID>
129129
> openstatus monitors info 12345
130+
> openstatus monitors info 12345 --time-range 7d
130131
131-
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.
132+
Fetch the monitor information including configuration, live status per region, and summary metrics.
132133

133134
Usage:
134135

@@ -138,9 +139,10 @@ $ openstatus [GLOBAL FLAGS] monitors info [COMMAND FLAGS] [ARGUMENTS...]
138139

139140
The following flags are supported:
140141

141-
| Name | Description | Default value | Environment variables |
142-
|-----------------------------|-----------------------------|:-------------:|:----------------------:|
143-
| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` |
142+
| Name | Description | Default value | Environment variables |
143+
|-----------------------------|----------------------------------------------|:-------------:|:----------------------:|
144+
| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` |
145+
| `--time-range="…"` | Time range for summary metrics (1d, 7d, 14d) | `1d` | *none* |
144146

145147
### `monitors list` subcommand
146148

@@ -322,6 +324,124 @@ The following flags are supported:
322324
| `--date="…"` | Date for the update (RFC 3339 format, defaults to now) | | *none* |
323325
| `--notify` | Notify subscribers about this update | `false` | *none* |
324326

327+
### `maintenance` command (aliases: `mt`)
328+
329+
Manage maintenance windows.
330+
331+
Usage:
332+
333+
```bash
334+
$ openstatus [GLOBAL FLAGS] maintenance [ARGUMENTS...]
335+
```
336+
337+
### `maintenance list` subcommand
338+
339+
List all maintenance windows.
340+
341+
> openstatus maintenance list
342+
> openstatus maintenance list --page-id abc --limit 10
343+
344+
Usage:
345+
346+
```bash
347+
$ openstatus [GLOBAL FLAGS] maintenance list [COMMAND FLAGS] [ARGUMENTS...]
348+
```
349+
350+
The following flags are supported:
351+
352+
| Name | Description | Default value | Environment variables |
353+
|-----------------------------|--------------------------------------------------|:-------------:|:----------------------:|
354+
| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` |
355+
| `--page-id="…"` | Filter by status page ID | | *none* |
356+
| `--limit="…"` | Maximum number of maintenances to return (1-100) | `0` | *none* |
357+
358+
### `maintenance info` subcommand
359+
360+
Get maintenance window details.
361+
362+
> openstatus maintenance info <MaintenanceID>
363+
> openstatus maintenance info 12345
364+
365+
Usage:
366+
367+
```bash
368+
$ openstatus [GLOBAL FLAGS] maintenance info [COMMAND FLAGS] [ARGUMENTS...]
369+
```
370+
371+
The following flags are supported:
372+
373+
| Name | Description | Default value | Environment variables |
374+
|-----------------------------|-----------------------------|:-------------:|:----------------------:|
375+
| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` |
376+
377+
### `maintenance create` subcommand
378+
379+
Create a maintenance window.
380+
381+
> openstatus maintenance create --title "DB Migration" --message "Upgrading database" --from 2026-04-01T10:00:00Z --to 2026-04-01T12:00:00Z --page-id 123
382+
383+
Usage:
384+
385+
```bash
386+
$ openstatus [GLOBAL FLAGS] maintenance create [COMMAND FLAGS] [ARGUMENTS...]
387+
```
388+
389+
The following flags are supported:
390+
391+
| Name | Description | Default value | Environment variables |
392+
|-----------------------------|--------------------------------------------------------|:-------------:|:----------------------:|
393+
| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` |
394+
| `--title="…"` | Title of the maintenance | | *none* |
395+
| `--message="…"` | Message describing the maintenance | | *none* |
396+
| `--from="…"` | Start time of the maintenance window (RFC 3339 format) | | *none* |
397+
| `--to="…"` | End time of the maintenance window (RFC 3339 format) | | *none* |
398+
| `--page-id="…"` | Status page ID to associate with this maintenance | | *none* |
399+
| `--component-ids="…"` | Comma-separated page component IDs | | *none* |
400+
| `--notify` | Notify subscribers about this maintenance | `false` | *none* |
401+
402+
### `maintenance update` subcommand
403+
404+
Update a maintenance window.
405+
406+
> openstatus maintenance update <MaintenanceID> [--title "New title"] [--message "New message"] [--from ...] [--to ...]
407+
408+
Usage:
409+
410+
```bash
411+
$ openstatus [GLOBAL FLAGS] maintenance update [COMMAND FLAGS] [ARGUMENTS...]
412+
```
413+
414+
The following flags are supported:
415+
416+
| Name | Description | Default value | Environment variables |
417+
|-----------------------------|-------------------------------------------------------------|:-------------:|:----------------------:|
418+
| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` |
419+
| `--title="…"` | New title for the maintenance | | *none* |
420+
| `--message="…"` | New message for the maintenance | | *none* |
421+
| `--from="…"` | New start time (RFC 3339 format) | | *none* |
422+
| `--to="…"` | New end time (RFC 3339 format) | | *none* |
423+
| `--component-ids="…"` | Comma-separated page component IDs (replaces existing list) | | *none* |
424+
425+
### `maintenance delete` subcommand
426+
427+
Delete a maintenance window.
428+
429+
> openstatus maintenance delete <MaintenanceID>
430+
> openstatus maintenance delete 12345 -y
431+
432+
Usage:
433+
434+
```bash
435+
$ openstatus [GLOBAL FLAGS] maintenance delete [COMMAND FLAGS] [ARGUMENTS...]
436+
```
437+
438+
The following flags are supported:
439+
440+
| Name | Description | Default value | Environment variables |
441+
|-----------------------------|---------------------------------|:-------------:|:----------------------:|
442+
| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` |
443+
| `--auto-accept` (`-y`) | Automatically accept the prompt | `false` | *none* |
444+
325445
### `status-page` command (aliases: `sp`)
326446

327447
Manage status pages.

0 commit comments

Comments
 (0)