Skip to content
This repository was archived by the owner on Nov 22, 2024. It is now read-only.

Commit 64f3a01

Browse files
committed
brought man page up to date
1 parent 618d02e commit 64f3a01

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

cli4/cli4.1

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,21 @@ cli4 \- Command line access to Cloudflare v4 API
88
[\fB\-V\fR|\fB\-\-version]
99
[\fB\-h\fR|\fB\-\-help]
1010
[\fB\-v\fR|\fB\-\-verbose]
11+
[\fB\-e\fR|\fB\-\-examples]
1112
[\fB\-q\fR|\fB\-\-quiet]
1213
[\fB\-j\fR|\fB\-\-json]
1314
[\fB\-y\fR|\fB\-\-yaml]
1415
[\fB\-n\fR|\fB\-\-ndjson]
1516
[\fB\-r\fR|\fB\-\-raw]
17+
[\fB\ir\fR|\fB\-\-image]
1618
[\fB\-d\fR|\fB\-\-dump]
19+
[\fB\-b\fR|\fB\-\-binary]
20+
[\fB\-A openapi-url\fR|\fB\-\-openapi openapi-url]
1721
[\fB\-p profile-name\fR|\fB\-\-profile profile-name]
1822
[\fBitem\fR=\fIvalue\fR ...]
23+
[=\fIvalue\fR ...]
1924
[\fBitem\fR=@\fIfilename\fR ...]
25+
[=@\fIfilename\fR ...]
2026
[\fB\-G\fR|\fB\-\-get]
2127
[\fB\-P\fR|\fB\-\-patch]
2228
[\fB\-O\fR|\fB\-\-post]
@@ -36,6 +42,8 @@ Display program version number and exit.
3642
This information (in a terse form).
3743
.IP "[\-v, \-\-verbose]"
3844
Provide some protcol debugging information.
45+
.IP "[\-e, \-\-example]"
46+
Show the path to the examples folder/directory.
3947
.IP "[\-q, \-\-quiet]"
4048
Don't output any JSON/YAML responses.
4149
.IP "[\-j, \-\-json]"
@@ -46,8 +54,16 @@ Output response data in YAML format (if yaml package installed).
4654
Output response data in NDJSON format (if jsonlines package installed).
4755
.IP "[\-r, \-\-raw]"
4856
Output JSON results in raw mode without splitting out the errors and results.
57+
.IP "[\-i, \-\-image]"
58+
Output results as binary (i.e. it's an image).
59+
This isn't normally needed as the API returns a Content-Type to indicate an image is being returned.
60+
This option can be used to allow the API output to be output without any processing (i.e. JSON formatted).
4961
.IP "[\-d, \-\-dump]"
5062
Output a list of all API calls included in the code.
63+
.IP "[\-b, \-\-binary]"
64+
Open files in binary mode.
65+
.IP "[-A \fIopenapi-url\fR, \-\-openapi \fIopenapi-url\fR]"
66+
Decode Cloudflare's OpenAPI spec and output all the known commands.
5167
.IP "[-p \fIprofile-name\fR, \-\-profile \fIprofile-name\fR]"
5268
Select a \fIprofile-name\fR from the configuration file (hence select custom \fIemail\fR/\fItoken\fR values).
5369
.IP "\-\-get"
@@ -72,6 +88,7 @@ The API command(s) to execute.
7288
.SH COMMAND(S)
7389
The command string uses slash (\fB/\fR) to seperate the verbs in the same way that the Cloudflare v4 API documentation does.
7490
Any verb starting with colon (\fB:\fR) is either converted to zone_id, user_id, organtization_id, or otherwise.
91+
Any verb starting with coloe (\fB:\fR) and followed by 32 hex chracters is passed thru raw.
7592
Any verb starting with two colons (\fB::\fR) is passed thru raw.
7693

7794
.SH RESULTS

0 commit comments

Comments
 (0)