summaryrefslogtreecommitdiffstats
path: root/extra/fatcat-cli.1
diff options
context:
space:
mode:
Diffstat (limited to 'extra/fatcat-cli.1')
-rw-r--r--extra/fatcat-cli.164
1 files changed, 64 insertions, 0 deletions
diff --git a/extra/fatcat-cli.1 b/extra/fatcat-cli.1
new file mode 100644
index 0000000..0831773
--- /dev/null
+++ b/extra/fatcat-cli.1
@@ -0,0 +1,64 @@
+.\" Generated by scdoc 1.9.0
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "fatcat-cli" "1" "2020-06-14" "fatcat.wiki CLI Manual Page"
+.P
+.SH NAME
+.P
+fatcat-cli - something something
+.P
+.SH SYNOPSIS
+.P
+fatcat-cli [FLAGS] [OPTIONS] <SUBCOMMAND>
+.P
+Subcommands:
+.P
+.RS 4
+create
+delete
+edit
+editgroup
+get
+help
+search
+status
+update
+.P
+.RE
+.SH DESCRIPTION
+.P
+.SH OPTIONS
+.P
+\fB-h, --help\fR
+.RS 4
+Prints help information
+.P
+.RE
+\fB-V, --version\fR
+.RS 4
+Prints version information
+.P
+.RE
+\fB-v, --verbose\fR
+.RS 4
+Pass many times for more log output
+By default, it'll only report errors. Passing `-v` one time also prints warnings, `-vv` enables info logging, `-vvv` debug, and `-vvvv` trace.
+.P
+.RE
+\fB--api-host <api-host>\fR [env: FATCAT_API_HOST] [default: https://api.fatcat.wiki]
+.P
+\fB--api-token <api-token>\fR [env: FATCAT_API_AUTH_TOKEN]
+.P
+\fB--search-host <search-host>\fR [env: FATCAT_SEARCH_HOST] [default: https://search.fatcat.wiki]
+.P
+.SH EXAMPLES
+.P
+Some examples of usage will go here, like:
+.P
+.RS 4
+fatcat-cli get thing
+.P
+.RE