forked from cloudflare/python-cloudflare
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial pass a unix man page for cli4
- Loading branch information
Showing
1 changed file
with
77 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
.TH CLI4 1 | ||
|
||
.SH NAME | ||
cli4 \- Command line access to CloudFlare v4 API | ||
|
||
.SH SYNOPSIS | ||
.B cli4 | ||
[\fB\-h\fR|\fB\-\-help] | ||
[\fB\-v\fR|\fB\-\-verbose] | ||
[\fB\-q\fR|\fB\-\-quiet] | ||
[\fB\-j\fR|\fB\-\-json] | ||
[\fB\-y\fR|\fB\-\-yaml] | ||
[\fBitem\fR=\fIvalue\fR ...] | ||
.IR /command ... | ||
|
||
.SH DESCRIPTION | ||
.B cli4 | ||
provides command line access to CloudFlare v4 API | ||
|
||
.SH OPTIONS | ||
.TP | ||
.IP "[\-h, \-\-help]" | ||
This information (in a terse form). | ||
.IP "[\-v, \-\-verbose]" | ||
Provide some protcol debugging information. | ||
.IP "[\-q, \-\-quiet]" | ||
Don't output any JSON/YAML responses | ||
.IP "[\-j, \-\-json]" | ||
Output in JSON format | ||
.IP "[\-y, \-\-yaml]" | ||
Output in YAML format | ||
.IP \-\-get | ||
Send HTTP request as a \fBGET\fR (the default). | ||
.IP \-\-patch | ||
Send HTTP request as a \fBPATCH\fR. | ||
.IP \-\-post | ||
Send HTTP request as a \fBPOST\fR. | ||
.IP \-\-put | ||
Send HTTP request as a \fBPUT\fR. | ||
.IP \-\-delete | ||
Send HTTP request as a \fBDELETE\fR. | ||
.IP item=\fIvalue\fR | ||
Set a paramater or data value to send with a \fBGET\fR, \fBPATCH\fR, \fBPOST\fR, \fBPUT\fR or \fBDELETE\fR command. The value is sent as a string. | ||
.IP item:=\fIvalue\fR | ||
Set a paramater or data value to send with a \fBGET\fR, \fBPATCH\fR, \fBPOST\fR, \fBPUT\fR or \fBDELETE\fR command. The value is sent as an interger. | ||
.IP /command... | ||
The API command. | ||
The command uses slash (\fB/\fR) to seperate the verbs in the same way that the CloudFlare v4 API documentation does. | ||
Any verb starting with colon (\fB:\fR) is either converted to zone_id, user_id, organtization_id, or otherwise. | ||
|
||
.SH RESULTS | ||
The output is either JSON or YAML formatted. | ||
|
||
.SH EXAMPLES | ||
.B cli4 /zones | ||
List infomation for all zones. | ||
.B cli4 /zones/:example.com | ||
List specific zone info. | ||
.B cli4 /zones/:example.com/settings | ||
List settings for a specific zone. | ||
.B cli4 --delete purge_everything=true /zones/:example.com/purge_cache | ||
Purge cache for a specific zone. | ||
.B cli4 --delete files='[http://example.com/css/styles.css]' /zones/:example.com/purge_cache | ||
Purge cache for a specific zone. | ||
.B cli4 --delete files='[http://example.com/css/styles.css,http://example.com/js/script.js] /zones/:example.com/purge_cache | ||
Purge cache for a specific zone. | ||
.B cli4 --delete tags='[tag1,tag2,tag3]' /zones/:example.com/purge_cache | ||
Purge cache for a specific zone. | ||
.B cli4 /zones/:example.com/available_plans | ||
List available plans for a zone. | ||
.B cli4 --patch status=active /zones/:example.com/dnssec | ||
Make DNSSEC active for specfic zone. | ||
.B cli4 /zones/:example.com/dnssec | ||
List DNSSEC infomation and status for a specific zone. | ||
|
||
.SH SEE ALSO | ||
The CloudFlare API can be found https://api.cloudflare.com/. Each API call is provided via a similarly named function within the CloudFlare class. |