From 869f74890c67e880696f3e11026628ee2e2cbcbb Mon Sep 17 00:00:00 2001 From: Thibault Le Ouay Date: Thu, 5 Jun 2025 22:29:36 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=98=AD=20fix=20man=20page?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .goreleaser.yaml | 4 +- openstatus-docs.1 | 87 ++++++++++++++++++++++++++++++++++++++++++++ openstatus-docs.md | 91 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 180 insertions(+), 2 deletions(-) create mode 100644 openstatus-docs.1 create mode 100644 openstatus-docs.md diff --git a/.goreleaser.yaml b/.goreleaser.yaml index 9bc12a5..146dcc5 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -41,7 +41,7 @@ archives: - goos: windows formats: [ 'zip' ] files: - - docs/* + - openstatus-docs.1 # replacements: # darwin: Darwin # linux: Linux @@ -65,7 +65,7 @@ brews: test: | system "#{bin}/openstatus --help" extra_install: | - man1.install "docs/openstatus-docs.1" + man1.install "openstatus-docs.1" repository: # Repository owner. # diff --git a/openstatus-docs.1 b/openstatus-docs.1 new file mode 100644 index 0000000..96662f3 --- /dev/null +++ b/openstatus-docs.1 @@ -0,0 +1,87 @@ +.\" Automatically generated by Pandoc 3.7.0.2 +.\" +.TH "" "" "" "" +.SH CLI +.SH NAME +openstatus \- This is OpenStatus Command Line Interface +.SH SYNOPSIS +openstatus +.SH DESCRIPTION +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 +.PP +\f[B]Usage\f[R]: +.IP +.EX +openstatus [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...] +.EE +.SH COMMANDS +.SS monitors +Manage your monitors +.SS create +Create monitors (beta) +.RS +.PP +openstatus monitors create [options] +.RE +.PP +\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token +.PP +\f[B]\(enauto\-accept, \-y\f[R]: Automatically accept the prompt +.PP +\f[B]\(enconfig\f[R]=\(lq\(lq: The configuration file containing monitor +information (default: openstatus.yaml) +.SS delete +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 +.PP +\f[B]\(enauto\-accept, \-y\f[R]: Automatically accept the prompt +.SS info +Get monitor information +.PP +\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token +.SS list +List all monitors +.RS +.PP +openstatus monitors list [options] +.RE +.PP +\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token +.PP +\f[B]\(enall\f[R]: List all monitors including inactive ones +.SS trigger +Trigger a monitor test +.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 +.RS +.PP +openstatus run[options] +.RE +.PP +\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token +.PP +\f[B]\(enconfig\f[R]=\(lq\(lq: The configuration file (default: +config.openstatus.yaml) +.SS whoami, w +Get your current workspace information +.RS +.PP +openstatus whoami [options] +.RE +.PP +\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token diff --git a/openstatus-docs.md b/openstatus-docs.md new file mode 100644 index 0000000..0d41661 --- /dev/null +++ b/openstatus-docs.md @@ -0,0 +1,91 @@ +# CLI + +# NAME + +openstatus - This is OpenStatus Command Line Interface + +# SYNOPSIS + +openstatus + +# DESCRIPTION + +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 + +**Usage**: + +``` +openstatus [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...] +``` + +# COMMANDS + +## monitors + +Manage your monitors + +### create + +Create monitors (beta) + +>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 + +>openstatus monitors delete [MonitorID] [options] + +**--access-token, -t**="": OpenStatus API Access Token + +**--auto-accept, -y**: Automatically accept the prompt + +### info + +Get monitor information + +**--access-token, -t**="": OpenStatus API Access Token + +### list + +List all monitors + +>openstatus monitors list [options] + +**--access-token, -t**="": OpenStatus API Access Token + +**--all**: List all monitors including inactive ones + +### trigger + +Trigger a monitor test + +>openstatus monitors trigger [MonitorId] [options] + +**--access-token, -t**="": OpenStatus API Access Token + +## run, r + +Run your synthetics tests + +>openstatus run[options] + +**--access-token, -t**="": OpenStatus API Access Token + +**--config**="": The configuration file (default: config.openstatus.yaml) + +## whoami, w + +Get your current workspace information + +>openstatus whoami [options] + +**--access-token, -t**="": OpenStatus API Access Token -- 2.51.2