From b65e2f8368d732299e08b6b41fa81146fbf2f951 Mon Sep 17 00:00:00 2001 From: Thibault Le Ouay Date: Wed, 2 Jul 2025 13:14:27 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=84=20docs=20generation=20improvment?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- cmd/docs/docs.go | 2 +- docs/openstatus-docs.md | 184 +++++++++++++------ docs/openstatus.1 | 387 +++++++++++++++++++++++++++++++++++----- 3 files changed, 476 insertions(+), 97 deletions(-) diff --git a/cmd/docs/docs.go b/cmd/docs/docs.go index 87caf3b..46889ac 100644 --- a/cmd/docs/docs.go +++ b/cmd/docs/docs.go @@ -9,7 +9,7 @@ import ( func main() { app := cmd.NewApp() - md, err := docs.ToMarkdown(app) + md, err := docs.ToTabularMarkdown(app , "openstatus") if err != nil { panic(err) } diff --git a/docs/openstatus-docs.md b/docs/openstatus-docs.md index c906813..138d3de 100644 --- a/docs/openstatus-docs.md +++ b/docs/openstatus-docs.md @@ -1,103 +1,187 @@ # OpenStatus CLI -# NAME +## CLI interface - openstatus -openstatus - This is OpenStatus Command Line Interface, the OpenStatus.dev CLI +OpenStatus is a command line interface for managing your monitors and triggering your synthetics tests. Please report any issues at https://github.com/openstatusHQ/cli/issues/new. -# SYNOPSIS +This is OpenStatus Command Line Interface, the OpenStatus.dev CLI. -openstatus +Usage: -# DESCRIPTION +```bash +$ openstatus [COMMAND] [COMMAND FLAGS] [ARGUMENTS...] +``` + +### `monitors` command + +Manage your monitors. + +Usage: + +```bash +$ openstatus [GLOBAL FLAGS] monitors [ARGUMENTS...] +``` + +### `monitors create` subcommand + +Create monitors (beta). + +> openstatus monitors create [options] + +Create the monitors defined in the openstatus.yaml file. + +Usage: + +```bash +$ openstatus [GLOBAL FLAGS] monitors create [COMMAND FLAGS] [ARGUMENTS...] +``` + +The following flags are supported: + +| Name | Description | Default value | Environment variables | +|-----------------------------|-------------------------------------------------------|:-----------------:|:----------------------:| +| `--config="…"` | The configuration file containing monitor information | `openstatus.yaml` | *none* | +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | +| `--auto-accept` (`-y`) | Automatically accept the prompt | `false` | *none* | -OpenStatus is a command line interface for managing your monitors and triggering your synthetics tests. +### `monitors delete` subcommand -Please report any issues at https://github.com/openstatusHQ/cli/issues/new +Delete a monitor. -**Usage**: +> openstatus monitors delete [MonitorID] [options] +Usage: + +```bash +$ openstatus [GLOBAL FLAGS] monitors delete [COMMAND FLAGS] [ARGUMENTS...] ``` -openstatus [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [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* | + +### `monitors export` subcommand + +Export all your monitors. + +> openstatus monitor export [options] + +Export all your monitors to YAML. + +Usage: + +```bash +$ openstatus [GLOBAL FLAGS] monitors export [COMMAND FLAGS] [ARGUMENTS...] ``` -# COMMANDS +The following flags are supported: -## monitors +| Name | Description | Default value | Environment variables | +|-----------------------------|-----------------------------|:-----------------:|:----------------------:| +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | +| `--output="…"` (`-o`) | The output file name | `openstatus.yaml` | *none* | -Manage your monitors +### `monitors info` subcommand -### create +Get a monitor information. -Create monitors (beta) +> openstatus monitor info [MonitorID] ->openstatus monitors create [options] +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. -**--access-token, -t**="": OpenStatus API Access Token +Usage: -**--auto-accept, -y**: Automatically accept the prompt +```bash +$ openstatus [GLOBAL FLAGS] monitors info [COMMAND FLAGS] [ARGUMENTS...] +``` -**--config**="": The configuration file containing monitor information (default: openstatus.yaml) +The following flags are supported: -### delete +| Name | Description | Default value | Environment variables | +|-----------------------------|-----------------------------|:-------------:|:----------------------:| +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | -Delete a monitor +### `monitors list` subcommand ->openstatus monitors delete [MonitorID] [options] +List all monitors. -**--access-token, -t**="": OpenStatus API Access Token +> openstatus monitors list [options] -**--auto-accept, -y**: Automatically accept the prompt +List all monitors. The list shows all your monitors attached to your workspace. It displays the ID, name, and URL of each monitor. -### export +Usage: -Export all your monitors +```bash +$ openstatus [GLOBAL FLAGS] monitors list [COMMAND FLAGS] [ARGUMENTS...] +``` ->openstatus monitor export [options] +The following flags are supported: -**--access-token, -t**="": OpenStatus API Access Token +| Name | Description | Default value | Environment variables | +|-----------------------------|-------------------------------------------|:-------------:|:----------------------:| +| `--all` | List all monitors including inactive ones | `false` | *none* | +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | -**--output, -o**="": The output file name (default: openstatus.yaml) +### `monitors trigger` subcommand -### info +Trigger a monitor execution. -Get a monitor information +> openstatus monitors trigger [MonitorId] [options] ->openstatus monitor info [MonitorID] +Trigger a monitor execution on demand. This command allows you to launch your tests on demand. -**--access-token, -t**="": OpenStatus API Access Token +Usage: -### list +```bash +$ openstatus [GLOBAL FLAGS] monitors trigger [COMMAND FLAGS] [ARGUMENTS...] +``` -List all monitors +The following flags are supported: ->openstatus monitors list [options] +| Name | Description | Default value | Environment variables | +|-----------------------------|-----------------------------|:-------------:|:----------------------:| +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | -**--access-token, -t**="": OpenStatus API Access Token +### `run` command (aliases: `r`) -**--all**: List all monitors including inactive ones +Run your synthetics tests. -### trigger +> openstatus run [options] -Trigger a monitor execution +Run the synthetic tests defined in the config.openstatus.yaml. ->openstatus monitors trigger [MonitorId] [options] +Usage: -**--access-token, -t**="": OpenStatus API Access Token +```bash +$ openstatus [GLOBAL FLAGS] run [COMMAND FLAGS] [ARGUMENTS...] +``` + +The following flags are supported: -## run, r +| Name | Description | Default value | Environment variables | +|-----------------------------|-----------------------------|:------------------------:|:----------------------:| +| `--config="…"` | The configuration file | `config.openstatus.yaml` | *none* | +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | -Run your synthetics tests +### `whoami` command (aliases: `w`) ->openstatus run [options] +Get your workspace information. -**--access-token, -t**="": OpenStatus API Access Token +> openstatus whoami [options] -**--config**="": The configuration file (default: config.openstatus.yaml) +Get your current workspace information, display the workspace name, slug, and plan. -## whoami, w +Usage: -Get your workspace information +```bash +$ openstatus [GLOBAL FLAGS] whoami [COMMAND FLAGS] [ARGUMENTS...] +``` ->openstatus whoami [options] +The following flags are supported: -**--access-token, -t**="": OpenStatus API Access Token +| Name | Description | Default value | Environment variables | +|-----------------------------|-----------------------------|:-------------:|:----------------------:| +| `--access-token="…"` (`-t`) | OpenStatus API Access Token | | `OPENSTATUS_API_TOKEN` | diff --git a/docs/openstatus.1 b/docs/openstatus.1 index b4489aa..3d167e3 100644 --- a/docs/openstatus.1 +++ b/docs/openstatus.1 @@ -1,103 +1,398 @@ +'\" t .\" Automatically generated by Pandoc 3.7.0.2 .\" .TH "" "" "" "" .SH OpenStatus CLI -.SH NAME -openstatus \- This is OpenStatus Command Line Interface, the -OpenStatus.dev CLI -.SH SYNOPSIS -openstatus -.SH DESCRIPTION +.SS CLI interface \- openstatus OpenStatus is a command line interface for managing your monitors and triggering your synthetics tests. -.PP Please report any issues at -https://github.com/openstatusHQ/cli/issues/new +https://github.com/openstatusHQ/cli/issues/new. +.PP +This is OpenStatus Command Line Interface, the OpenStatus.dev CLI. +.PP +Usage: +.IP +.EX +$ openstatus [COMMAND] [COMMAND FLAGS] [ARGUMENTS...] +.EE +.SS \f[CR]monitors\f[R] command +Manage your monitors. .PP -\f[B]Usage\f[R]: +Usage: .IP .EX -openstatus [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...] +$ openstatus [GLOBAL FLAGS] monitors [ARGUMENTS...] .EE -.SH COMMANDS -.SS monitors -Manage your monitors -.SS create -Create monitors (beta) +.SS \f[CR]monitors create\f[R] subcommand +Create monitors (beta). .RS .PP openstatus monitors create [options] .RE .PP -\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token +Create the monitors defined in the openstatus.yaml file. .PP -\f[B]\(enauto\-accept, \-y\f[R]: Automatically accept the prompt +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] monitors create [COMMAND FLAGS] [ARGUMENTS...] +.EE .PP -\f[B]\(enconfig\f[R]=\(lq\(lq: The configuration file containing monitor -information (default: openstatus.yaml) -.SS delete -Delete a monitor +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] +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 [MonitorID] [options] .RE .PP -\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] monitors delete [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: .PP -\f[B]\(enauto\-accept, \-y\f[R]: Automatically accept the prompt -.SS export -Export all your monitors +.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 export\f[R] subcommand +Export all your monitors. .RS .PP openstatus monitor export [options] .RE .PP -\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token +Export all your monitors to YAML. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] monitors export [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: .PP -\f[B]\(enoutput, \-o\f[R]=\(lq\(lq: The output file name (default: -openstatus.yaml) -.SS info -Get a monitor information +.TS +tab(@); +lw(20.1n) lw(20.1n) cw(13.2n) 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]\-\-output=\(dq\&...\(dq\f[R] (\f[CR]\-o\f[R]) +T}@T{ +The output file name +T}@T{ +\f[CR]openstatus.yaml\f[R] +T}@T{ +\f[I]none\f[R] +T} +.TE +.SS \f[CR]monitors info\f[R] subcommand +Get a monitor information. .RS .PP openstatus monitor info [MonitorID] .RE .PP -\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token -.SS list -List all monitors +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. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] monitors 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]monitors list\f[R] subcommand +List all monitors. .RS .PP openstatus monitors list [options] .RE .PP -\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token +List all monitors. +The list shows all your monitors attached to your workspace. +It displays the ID, name, and URL of each monitor. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] monitors list [COMMAND FLAGS] [ARGUMENTS...] +.EE +.PP +The following flags are supported: .PP -\f[B]\(enall\f[R]: List all monitors including inactive ones -.SS trigger -Trigger a monitor execution +.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]\-\-all\f[R] +T}@T{ +List all monitors including inactive ones +T}@T{ +\f[CR]false\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]monitors trigger\f[R] subcommand +Trigger a monitor execution. .RS .PP openstatus monitors trigger [MonitorId] [options] .RE .PP -\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token -.SS run, r -Run your synthetics tests +Trigger a monitor execution on demand. +This command allows you to launch your tests on demand. +.PP +Usage: +.IP +.EX +$ openstatus [GLOBAL FLAGS] monitors trigger [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 synthetics tests. .RS .PP openstatus run [options] .RE .PP -\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token +Run the synthetic tests defined in the config.openstatus.yaml. .PP -\f[B]\(enconfig\f[R]=\(lq\(lq: The configuration file (default: -config.openstatus.yaml) -.SS whoami, w -Get your workspace information +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 [options] .RE .PP -\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token +Get your current workspace information, display 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 -- 2.51.2