You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: skills/cli/SKILL.md
+84-3Lines changed: 84 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
---
2
2
name: openstatus-cli
3
3
description: |
4
-
OpenStatus CLI for managing uptime monitors, incident reports, status pages, and synthetic tests. Use this skill whenever the user wants to monitor a website or API, set up uptime checks, create or manage monitors, report an incident, update a status page, run synthetic tests, check latency or availability, define monitors as code, or use the openstatus command. Also trigger when the user says "is my site up", "check my endpoint", "create a status report", "monitor this URL", "run uptime tests", "set up monitoring", "our API is down", or mentions openstatus in any context. This skill knows the full CLI — commands, flags, config format, and workflows — so Claude can act without guessing.
4
+
OpenStatus CLI for managing uptime monitors, incident reports, status pages, maintenance windows, and synthetic tests. Use this skill whenever the user wants to monitor a website or API, set up uptime checks, create or manage monitors, report an incident, update a status page, schedule maintenance, run synthetic tests, check latency or availability, define monitors as code, or use the openstatus command. Also trigger when the user says "is my site up", "check my endpoint", "create a status report", "monitor this URL", "run uptime tests", "set up monitoring", "our API is down", "schedule maintenance", "maintenance window", "planned downtime", or mentions openstatus in any context. This skill knows the full CLI — commands, flags, config format, and workflows — so Claude can act without guessing.
5
5
allowed-tools:
6
6
- Bash(openstatus *)
7
7
---
8
8
9
9
# OpenStatus CLI
10
10
11
-
Manage uptime monitors, incident reports, and status pages from the terminal. The CLI supports monitors-as-code via YAML config files.
11
+
Manage uptime monitors, incident reports, status pages, and maintenance windows from the terminal. The CLI supports monitors-as-code via YAML config files.
12
12
13
13
Run `openstatus --help` or `openstatus <command> --help` for full option details.
14
14
@@ -45,10 +45,15 @@ Token resolution order:
45
45
| Delete incident |`status-report delete <ID>`| Remove a status report |
46
46
| List status pages |`status-page list`| See all your status pages |
47
47
| Get status page details |`status-page info <ID>`| View page config, components, theme |
48
+
| Create a maintenance window |`maintenance create`| Plan a maintenance window for a status page |
49
+
| List maintenance windows |`maintenance list`| See scheduled/active/completed maintenance |
50
+
| Get maintenance details |`maintenance info <ID>`| View full details of a maintenance window |
51
+
| Update a maintenance window |`maintenance update <ID>`| Change title, message, or time window |
52
+
| Delete a maintenance window |`maintenance delete <ID>`| Remove a maintenance window |
48
53
| Run synthetic tests |`run`| Execute on-demand tests for specific monitors |
49
54
| Check workspace |`whoami`| Verify auth and workspace info |
@@ -71,6 +76,8 @@ This is the primary way to manage monitors. Write a YAML config, then let the CL
71
76
72
77
### Incident lifecycle
73
78
79
+
Use status reports for **unplanned** outages and incidents.
80
+
74
81
Status reports follow a progression: `investigating` -> `identified` -> `monitoring` -> `resolved`. These are the only valid status values — the CLI rejects anything else.
75
82
76
83
**1. Find your status page ID and component IDs first:**
**1. Find your status page ID and component IDs first:**
179
+
```bash
180
+
openstatus status-page list
181
+
openstatus status-page info <PAGE_ID># shows components grouped by section
182
+
```
183
+
184
+
**2. Create a maintenance window:**
185
+
```bash
186
+
openstatus maintenance create \
187
+
--title "Database Migration" \
188
+
--message "Scheduled database migration to improve performance" \
189
+
--from "2026-04-05T02:00:00Z" \
190
+
--to "2026-04-05T04:00:00Z" \
191
+
--page-id 123 \
192
+
--component-ids "comp-1,comp-2" \
193
+
--notify
194
+
```
195
+
196
+
On success, the CLI prints the maintenance ID and suggests the next command:
197
+
```
198
+
Maintenance created successfully (ID: 789)
199
+
Run 'openstatus maintenance info 789' to see details
200
+
```
201
+
202
+
**`create` flags:**
203
+
204
+
| Flag | Required | Description |
205
+
|------|----------|-------------|
206
+
|`--title`| yes | Maintenance title |
207
+
|`--message`| yes | Description of the maintenance |
208
+
|`--from`| yes | Start time in RFC 3339 format (e.g. `2026-04-05T02:00:00Z`) |
209
+
|`--to`| yes | End time in RFC 3339 format |
210
+
|`--page-id`| yes | Status page ID (get it from `status-page list`) |
211
+
|`--component-ids`| no | Comma-separated component IDs in a single string: `"id1,id2"`|
212
+
|`--notify`| no | Notify status page subscribers |
213
+
214
+
Status is computed automatically: `scheduled` (before `--from`), `in_progress` (between `--from` and `--to`), `completed` (after `--to`). There is no `--status` flag.
215
+
216
+
**3. Update a maintenance window:**
217
+
```bash
218
+
openstatus maintenance update <ID> \
219
+
--title "Extended Maintenance" \
220
+
--to "2026-04-05T06:00:00Z"
221
+
```
222
+
223
+
Only provided flags are updated. At least one of `--title`, `--message`, `--from`, `--to`, or `--component-ids` must be set. `--component-ids` replaces the entire list.
224
+
225
+
**4. List and filter:**
226
+
```bash
227
+
openstatus maintenance list # all maintenance windows
228
+
openstatus maintenance list --page-id 123 # filter by page
229
+
openstatus maintenance list --limit 10 # limit results
230
+
```
231
+
232
+
**5. View details:**
233
+
```bash
234
+
openstatus maintenance info <ID>
235
+
```
236
+
237
+
**6. Delete:**
238
+
```bash
239
+
openstatus maintenance delete <ID># prompts for confirmation
0 commit comments