11.TH CLI4 1
22
33.SH NAME
4- cli4 \- Command line access to CloudFlare v4 API
4+ cli4 \- Command line access to Cloudflare v4 API
55
66.SH SYNOPSIS
77.B cli4
8- [\fB \- V \fR ]
8+ [\fB \- V \fR | \fB \-\- version ]
99[ \fB \- h \fR |\fB \-\- help]
1010[ \fB \- v \fR |\fB \-\- verbose]
1111[ \fB \- q \fR |\fB \-\- quiet]
1212[ \fB \- j \fR |\fB \-\- json]
1313[ \fB \- y \fR |\fB \-\- yaml]
1414[ \fB \- n \fR |\fB \-\- ndjson]
15+ [ \fB \- r \fR |\fB \-\- raw]
16+ [ \fB \- d \fR |\fB \-\- dump]
17+ [ \fB \- p profile-name \fR |\fB \-\- profile profile-name]
1518[ \fB item \fR =\fI value \fR ...]
19+ [\fB item \fR =@\fI filename \fR ...]
1620[\fB \- G \fR |\fB \-\- get]
1721[ \fB \- P \fR |\fB \-\- patch]
1822[ \fB \- O \fR |\fB \-\- post]
@@ -22,7 +26,7 @@ cli4 \- Command line access to CloudFlare v4 API
2226
2327.SH DESCRIPTION
2428.B cli4
25- provides command line access to CloudFlare v4 API
29+ provides command line access to Cloudflare v4 API
2630
2731.SH OPTIONS
2832.TP
@@ -40,6 +44,12 @@ Output response data in JSON format (the default).
4044Output response data in YAML format (if yaml package installed).
4145.IP " [\- n, \-\- ndjson]"
4246Output response data in NDJSON format (if jsonlines package installed).
47+ .IP " [\- r, \-\- raw]"
48+ Output JSON results in raw mode without splitting out the errors and results.
49+ .IP " [\- d, \-\- dump]"
50+ Output a list of all API calls included in the code.
51+ .IP " [-p \fI profile-name \fR , \-\- profile \fI profile-name \fR ]"
52+ Select a \fI profile-name \fR from the configuration file (hence select custom \fI email \fR /\fI token \fR values).
4353.IP " \-\- get"
4454Send HTTP request as a \fB GET \fR (the default).
4555.IP " \-\- patch"
@@ -54,9 +64,13 @@ Send HTTP request as a \fBDELETE\fR.
5464Set a paramater or data value to send with a \fB GET \fR , \fB PATCH \fR , \fB POST \fR , \fB PUT \fR or \fB DELETE \fR command. The value is sent as a string.
5565.IP item:= \fI value \fR
5666Set a paramater or data value to send with a \fB GET \fR , \fB PATCH \fR , \fB POST \fR , \fB PUT \fR or \fB DELETE \fR command. The value is sent as an interger.
57- .IP /command...
58- The API command.
59- The command uses slash (\fB / \fR ) to seperate the verbs in the same way that the CloudFlare v4 API documentation does.
67+ .IP item=@ \fI filename \fR
68+ Set a paramater or data value to send with a \fB POST \fR or \fB PUT \fR command. The value is based on the content of the file.
69+ .IP " \fI /command ... \fR "
70+ The API command(s) to execute.
71+
72+ .SH COMMAND(S)
73+ The command string uses slash (\fB / \fR ) to seperate the verbs in the same way that the Cloudflare v4 API documentation does.
6074Any verb starting with colon (\fB : \fR ) is either converted to zone_id, user_id, organtization_id, or otherwise.
6175
6276.SH RESULTS
@@ -94,4 +108,4 @@ Make DNSSEC active for specfic zone.
94108List DNSSEC infomation and status for a specific zone.
95109
96110.SH SEE ALSO
97- The CloudFlare API can be found https://api.cloudflare.com/. Each API call is provided via a similarly named function within the CloudFlare class.
111+ The Cloudflare API can be found https://api.cloudflare.com/. Each API call is provided via a similarly named function within the Cloudflare class.
0 commit comments