Openstatus
www.openstatus.dev
📚 improve docs (#1275)
authored by
Thibault Le Ouay
and committed by
GitHub
b45e6016
af7e82da
+74
-12
+51
-11
apps/docs/src/content/docs/cli/commands/monitors.mdx
+51
-11
apps/docs/src/content/docs/cli/commands/monitors.mdx
···
5
5
6
6
The monitors command is used to manage your monitors. You trigger, view and list your monitors using this command.
7
7
8
-
## Info
9
-
You can get the details of a monitor using the following command.
8
+
### create (beta)
9
+
10
+
Create monitors
10
11
11
12
```bash
12
-
openstatus monitors info <monitor-id>
13
+
openstatus monitors create [options]
13
14
```
15
+
**--access-token, -t**="": OpenStatus API Access Token
14
16
17
+
**--auto-accept, -y**: Automatically accept the prompt
15
18
19
+
**--config**="": The configuration file containing monitor information (default: openstatus.yaml)
16
20
17
-
## List
21
+
### delete
18
22
19
-
You can list all the monitors using the following command.
23
+
Delete a monitor
20
24
21
25
```bash
22
-
openstatus monitors list
26
+
openstatus monitors delete [MonitorID] [options]
23
27
```
24
28
25
-
### Options
29
+
**--access-token, -t**="": OpenStatus API Access Token
26
30
27
-
- `--all` - List all the monitors including the inactive ones.
31
+
**--auto-accept, -y**: Automatically accept the prompt
28
32
29
-
## Trigger
33
+
### export
30
34
31
-
You can trigger a monitor using the following command.
35
+
Export all your monitors
32
36
33
37
```bash
34
-
openstatus monitors trigger <monitor-id>
38
+
openstatus monitors export [options]
35
39
```
40
+
41
+
**--access-token, -t**="": OpenStatus API Access Token
42
+
43
+
**--output, -o**="": The output file name (default: openstatus.yaml)
44
+
45
+
### info
46
+
47
+
Get a monitor information
48
+
49
+
```bash
50
+
openstatus monitors info [MonitorID] [options]
51
+
```
52
+
53
+
**--access-token, -t**="": OpenStatus API Access Token
54
+
55
+
### list
56
+
57
+
List all monitors
58
+
59
+
```bash
60
+
openstatus monitors list [options]
61
+
```
62
+
63
+
**--access-token, -t**="": OpenStatus API Access Token
64
+
65
+
**--all**: List all monitors including inactive ones
66
+
67
+
### trigger
68
+
69
+
Trigger a monitor execution
70
+
71
+
```bash
72
+
openstatus monitors trigger [MonitorId] [options]
73
+
```
74
+
75
+
**--access-token, -t**="": OpenStatus API Access Token
+6
apps/docs/src/content/docs/cli/commands/whoami.mdx
+6
apps/docs/src/content/docs/cli/commands/whoami.mdx
+1
-1
apps/docs/src/content/docs/cli/getting-started.mdx
+1
-1
apps/docs/src/content/docs/cli/getting-started.mdx
apps/web/public/assets/changelog/cli-update.png
apps/web/public/assets/changelog/cli-update.png
This is a binary file and will not be displayed.
+16
apps/web/src/content/changelog/cli-improvement.mdx
+16
apps/web/src/content/changelog/cli-improvement.mdx
···
1
+
---
2
+
title: New CLI commands
3
+
description: We have updated our CLI to provide more features and improve the user experience.
4
+
image: /assets/changelog/cli-update.png
5
+
publishedAt: 2025-06-16
6
+
---
7
+
8
+
Upgrade your CLI to the latest version for enhanced functionality and a better user experience.
9
+
10
+
## New Features
11
+
12
+
- Create monitors: Create your monitors defined in the configuration file.
13
+
- Export monitors: Export all your workspace monitors to a YAML file.
14
+
15
+
16
+
Check out our [CLI documentation](https://docs.openstatus.dev/cli/getting-started/) for more information.