Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
📚 improve docs (#1275)
Thibault Le Ouayb45e6016b965
diff --git a/apps/docs/src/content/docs/cli/commands/monitors.mdx b/apps/docs/src/content/docs/cli/commands/monitors.mdxindex 71b903bc7..2b0a73a64 100644--- a/apps/docs/src/content/docs/cli/commands/monitors.mdx+++ b/apps/docs/src/content/docs/cli/commands/monitors.mdx@@ -5,31 +5,71 @@ description: "Manage your monitors in OpenStatus from the command line"The monitors command is used to manage your monitors. You trigger, view and list your monitors using this command.-## Info-You can get the details of a monitor using the following command.+### create (beta)++Create monitors++```bash+openstatus monitors create [options]+```+**--access-token, -t**="": OpenStatus API Access Token++**--auto-accept, -y**: Automatically accept the prompt++**--config**="": The configuration file containing monitor information (default: openstatus.yaml)++### delete++Delete a monitor++```bash+openstatus monitors delete [MonitorID] [options]+```++**--access-token, -t**="": OpenStatus API Access Token++**--auto-accept, -y**: Automatically accept the prompt++### export++Export all your monitors```bash-openstatus monitors info <monitor-id>+openstatus monitors export [options]```+**--access-token, -t**="": OpenStatus API Access Token+**--output, -o**="": The output file name (default: openstatus.yaml)-## List+### info-You can list all the monitors using the following command.+Get a monitor information```bash-openstatus monitors list+openstatus monitors info [MonitorID] [options]```-### Options+**--access-token, -t**="": OpenStatus API Access Token-- `--all` - List all the monitors including the inactive ones.+### list-## Trigger+List all monitors-You can trigger a monitor using the following command.+```bash+openstatus monitors list [options]+```++**--access-token, -t**="": OpenStatus API Access Token++**--all**: List all monitors including inactive ones++### trigger++Trigger a monitor execution```bash-openstatus monitors trigger <monitor-id>+openstatus monitors trigger [MonitorId] [options]```++**--access-token, -t**="": OpenStatus API Access Tokendiff --git a/apps/docs/src/content/docs/cli/commands/whoami.mdx b/apps/docs/src/content/docs/cli/commands/whoami.mdxindex a85843ac5..4df09e029 100644--- a/apps/docs/src/content/docs/cli/commands/whoami.mdx+++ b/apps/docs/src/content/docs/cli/commands/whoami.mdx@@ -4,3 +4,9 @@ description: "How to check the currently authenticated user in OpenStatus with t---The `whoami` command is used to display the currently authenticated user. This command is useful to check if you are logged in and to see the workspace details.++```+openstatus whoami [options]+```++**--access-token, -t**="": OpenStatus API Access Tokendiff --git a/apps/docs/src/content/docs/cli/getting-started.mdx b/apps/docs/src/content/docs/cli/getting-started.mdxindex 9973b7d39..9d4aad824 100644--- a/apps/docs/src/content/docs/cli/getting-started.mdx+++ b/apps/docs/src/content/docs/cli/getting-started.mdx@@ -27,7 +27,7 @@ brew tap openstatusHQ/cli<br/>```bash-brew install openstatus+brew install openstatus --cask```Then you can run the following command to verify the installation.diff --git a/apps/web/public/assets/changelog/cli-update.png b/apps/web/public/assets/changelog/cli-update.pngnew file mode 100644index 000000000..0c28b775dBinary files /dev/null and b/apps/web/public/assets/changelog/cli-update.png differdiff --git a/apps/web/src/content/changelog/cli-improvement.mdx b/apps/web/src/content/changelog/cli-improvement.mdxnew file mode 100644index 000000000..87e493651--- /dev/null+++ b/apps/web/src/content/changelog/cli-improvement.mdx@@ -0,0 +1,16 @@+---+title: New CLI commands+description: We have updated our CLI to provide more features and improve the user experience.+image: /assets/changelog/cli-update.png+publishedAt: 2025-06-16+---++Upgrade your CLI to the latest version for enhanced functionality and a better user experience.++## New Features++- Create monitors: Create your monitors defined in the configuration file.+- Export monitors: Export all your workspace monitors to a YAML file.+++Check out our [CLI documentation](https://docs.openstatus.dev/cli/getting-started/) for more information.