From 8958accc97c30a5fb97d196f0415fd32b8de7796 Mon Sep 17 00:00:00 2001 From: Thibault Le Ouay Date: Mon, 16 Jun 2025 08:09:22 +0200 Subject: [PATCH] =?UTF-8?q?=E2=9C=8D=EF=B8=8F=20docs=20improvement?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/openstatus-docs.md | 10 +++++++--- docs/openstatus.1 | 13 ++++++++++--- internal/monitors/monitor_export.go | 1 + internal/monitors/monitor_info.go | 1 + internal/monitors/monitor_trigger.go | 2 +- internal/run/run.go | 2 +- internal/whoami/whoami.go | 3 ++- 7 files changed, 23 insertions(+), 9 deletions(-) diff --git a/docs/openstatus-docs.md b/docs/openstatus-docs.md index 5d48d28..bd4c0f6 100644 --- a/docs/openstatus-docs.md +++ b/docs/openstatus-docs.md @@ -10,7 +10,7 @@ openstatus # DESCRIPTION -OpenStatus is a command line interface for managing your monitors and triggering your synthetics tests. +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 @@ -52,6 +52,8 @@ Delete a monitor Export all your monitors +>openstatus monitor export [options] + **--access-token, -t**="": OpenStatus API Access Token **--output, -o**="": The output file name (default: openstatus.yaml) @@ -60,6 +62,8 @@ Export all your monitors Get a monitor information +>openstatus monitor info [MonitorID] + **--access-token, -t**="": OpenStatus API Access Token ### list @@ -84,7 +88,7 @@ Trigger a monitor execution Run your synthetics tests ->openstatus run[options] +>openstatus run [options] **--access-token, -t**="": OpenStatus API Access Token @@ -92,7 +96,7 @@ Run your synthetics tests ## whoami, w -Get your current workspace information, display the workspace name, slug, and plan +Get your workspace information >openstatus whoami [options] diff --git a/docs/openstatus.1 b/docs/openstatus.1 index d0dda41..b4489aa 100644 --- a/docs/openstatus.1 +++ b/docs/openstatus.1 @@ -47,6 +47,10 @@ openstatus monitors delete [MonitorID] [options] \f[B]\(enauto\-accept, \-y\f[R]: Automatically accept the prompt .SS export 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 .PP @@ -54,6 +58,10 @@ Export all your monitors openstatus.yaml) .SS info 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 @@ -78,7 +86,7 @@ openstatus monitors trigger [MonitorId] [options] Run your synthetics tests .RS .PP -openstatus run[options] +openstatus run [options] .RE .PP \f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token @@ -86,8 +94,7 @@ openstatus run[options] \f[B]\(enconfig\f[R]=\(lq\(lq: The configuration file (default: config.openstatus.yaml) .SS whoami, w -Get your current workspace information, display the workspace name, -slug, and plan +Get your workspace information .RS .PP openstatus whoami [options] diff --git a/internal/monitors/monitor_export.go b/internal/monitors/monitor_export.go index c72d180..9af8f0b 100644 --- a/internal/monitors/monitor_export.go +++ b/internal/monitors/monitor_export.go @@ -138,6 +138,7 @@ func GetMonitorExportCmd() *cli.Command { monitorInfoCmd := cli.Command{ Name: "export", Usage: "Export all your monitors", + UsageText: "openstatus monitor export [options]", Description: "Export all your monitors to YAML", Action: func(ctx context.Context, cmd *cli.Command) error { // monitorId := cmd.Args().Get(0) diff --git a/internal/monitors/monitor_info.go b/internal/monitors/monitor_info.go index f89e17d..2709b6c 100644 --- a/internal/monitors/monitor_info.go +++ b/internal/monitors/monitor_info.go @@ -110,6 +110,7 @@ func GetMonitorInfoCmd() *cli.Command { monitorInfoCmd := cli.Command{ Name: "info", Usage: "Get a monitor information", + UsageText: "openstatus monitor info [MonitorID]", Description: "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.", Action: func(ctx context.Context, cmd *cli.Command) error { monitorId := cmd.Args().Get(0) diff --git a/internal/monitors/monitor_trigger.go b/internal/monitors/monitor_trigger.go index 96069b8..d6a72d0 100644 --- a/internal/monitors/monitor_trigger.go +++ b/internal/monitors/monitor_trigger.go @@ -55,8 +55,8 @@ func GetMonitorsTriggerCmd() *cli.Command { monitorsCmd := cli.Command{ Name: "trigger", Usage: "Trigger a monitor execution", - Description: "Trigger a monitor execution on demand. This command allows you to launch your tests on demand.", UsageText: "openstatus monitors trigger [MonitorId] [options]", + Description: "Trigger a monitor execution on demand. This command allows you to launch your tests on demand.", Flags: []cli.Flag{ &cli.StringFlag{ Name: "access-token", diff --git a/internal/run/run.go b/internal/run/run.go index 96f4d52..709ef67 100644 --- a/internal/run/run.go +++ b/internal/run/run.go @@ -119,7 +119,7 @@ func RunCmd() *cli.Command { Name: "run", Aliases: []string{"r"}, Usage: "Run your synthetics tests", - UsageText: "openstatus run[options]", + UsageText: "openstatus run [options]", Description: "Run the synthetic tests defined in the config.openstatus.yaml", Action: func(ctx context.Context, cmd *cli.Command) error { diff --git a/internal/whoami/whoami.go b/internal/whoami/whoami.go index 5bea130..0b9473f 100644 --- a/internal/whoami/whoami.go +++ b/internal/whoami/whoami.go @@ -46,9 +46,10 @@ func GetWhoamiCmd(httpClient *http.Client, apiKey string) error { func WhoamiCmd() *cli.Command { whoamiCmd := cli.Command{ Name: "whoami", + Usage: "Get your workspace information", Aliases: []string{"w"}, UsageText: "openstatus whoami [options]", - Usage: "Get your current workspace information, display the workspace name, slug, and plan", + Description: "Get your current workspace information, display the workspace name, slug, and plan", Action: func(ctx context.Context, cmd *cli.Command) error { fmt.Println("Your current workspace information") err := GetWhoamiCmd(http.DefaultClient, cmd.String("access-token")) -- 2.51.2