Skip to content

Commit 869f748

Browse files
😭 fix man page
1 parent 6ce12db commit 869f748

3 files changed

Lines changed: 180 additions & 2 deletions

File tree

‎.goreleaser.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ archives:
4141
- goos: windows
4242
formats: [ 'zip' ]
4343
files:
44-
- docs/*
44+
- openstatus-docs.1
4545
# replacements:
4646
# darwin: Darwin
4747
# linux: Linux
@@ -65,7 +65,7 @@ brews:
6565
test: |
6666
system "#{bin}/openstatus --help"
6767
extra_install: |
68-
man1.install "docs/openstatus-docs.1"
68+
man1.install "openstatus-docs.1"
6969
repository:
7070
# Repository owner.
7171
#

‎openstatus-docs.1‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
.\" Automatically generated by Pandoc 3.7.0.2
2+
.\"
3+
.TH "" "" "" ""
4+
.SH CLI
5+
.SH NAME
6+
openstatus \- This is OpenStatus Command Line Interface
7+
.SH SYNOPSIS
8+
openstatus
9+
.SH DESCRIPTION
10+
OpenStatus is a command line interface for managing your monitors and
11+
triggering your synthetics tests.
12+
.PP
13+
Please report any issues at
14+
https://github.com/openstatusHQ/cli/issues/new
15+
.PP
16+
\f[B]Usage\f[R]:
17+
.IP
18+
.EX
19+
openstatus [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...]
20+
.EE
21+
.SH COMMANDS
22+
.SS monitors
23+
Manage your monitors
24+
.SS create
25+
Create monitors (beta)
26+
.RS
27+
.PP
28+
openstatus monitors create [options]
29+
.RE
30+
.PP
31+
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
32+
.PP
33+
\f[B]\(enauto\-accept, \-y\f[R]: Automatically accept the prompt
34+
.PP
35+
\f[B]\(enconfig\f[R]=\(lq\(lq: The configuration file containing monitor
36+
information (default: openstatus.yaml)
37+
.SS delete
38+
Delete a monitor
39+
.RS
40+
.PP
41+
openstatus monitors delete [MonitorID] [options]
42+
.RE
43+
.PP
44+
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
45+
.PP
46+
\f[B]\(enauto\-accept, \-y\f[R]: Automatically accept the prompt
47+
.SS info
48+
Get monitor information
49+
.PP
50+
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
51+
.SS list
52+
List all monitors
53+
.RS
54+
.PP
55+
openstatus monitors list [options]
56+
.RE
57+
.PP
58+
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
59+
.PP
60+
\f[B]\(enall\f[R]: List all monitors including inactive ones
61+
.SS trigger
62+
Trigger a monitor test
63+
.RS
64+
.PP
65+
openstatus monitors trigger [MonitorId] [options]
66+
.RE
67+
.PP
68+
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
69+
.SS run, r
70+
Run your synthetics tests
71+
.RS
72+
.PP
73+
openstatus run[options]
74+
.RE
75+
.PP
76+
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token
77+
.PP
78+
\f[B]\(enconfig\f[R]=\(lq\(lq: The configuration file (default:
79+
config.openstatus.yaml)
80+
.SS whoami, w
81+
Get your current workspace information
82+
.RS
83+
.PP
84+
openstatus whoami [options]
85+
.RE
86+
.PP
87+
\f[B]\(enaccess\-token, \-t\f[R]=\(lq\(lq: OpenStatus API Access Token

‎openstatus-docs.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# CLI
2+
3+
# NAME
4+
5+
openstatus - This is OpenStatus Command Line Interface
6+
7+
# SYNOPSIS
8+
9+
openstatus
10+
11+
# DESCRIPTION
12+
13+
OpenStatus is a command line interface for managing your monitors and triggering your synthetics tests.
14+
15+
Please report any issues at https://github.com/openstatusHQ/cli/issues/new
16+
17+
**Usage**:
18+
19+
```
20+
openstatus [GLOBAL OPTIONS] [command [COMMAND OPTIONS]] [ARGUMENTS...]
21+
```
22+
23+
# COMMANDS
24+
25+
## monitors
26+
27+
Manage your monitors
28+
29+
### create
30+
31+
Create monitors (beta)
32+
33+
>openstatus monitors create [options]
34+
35+
**--access-token, -t**="": OpenStatus API Access Token
36+
37+
**--auto-accept, -y**: Automatically accept the prompt
38+
39+
**--config**="": The configuration file containing monitor information (default: openstatus.yaml)
40+
41+
### delete
42+
43+
Delete a monitor
44+
45+
>openstatus monitors delete [MonitorID] [options]
46+
47+
**--access-token, -t**="": OpenStatus API Access Token
48+
49+
**--auto-accept, -y**: Automatically accept the prompt
50+
51+
### info
52+
53+
Get monitor information
54+
55+
**--access-token, -t**="": OpenStatus API Access Token
56+
57+
### list
58+
59+
List all monitors
60+
61+
>openstatus monitors list [options]
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 test
70+
71+
>openstatus monitors trigger [MonitorId] [options]
72+
73+
**--access-token, -t**="": OpenStatus API Access Token
74+
75+
## run, r
76+
77+
Run your synthetics tests
78+
79+
>openstatus run[options]
80+
81+
**--access-token, -t**="": OpenStatus API Access Token
82+
83+
**--config**="": The configuration file (default: config.openstatus.yaml)
84+
85+
## whoami, w
86+
87+
Get your current workspace information
88+
89+
>openstatus whoami [options]
90+
91+
**--access-token, -t**="": OpenStatus API Access Token

0 commit comments

Comments
 (0)