aboutsummaryrefslogtreecommitdiffstats
path: root/extra
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@archive.org>2021-02-09 20:13:05 -0800
committerBryan Newbold <bnewbold@archive.org>2021-02-09 20:13:05 -0800
commit260ae4ec7ee4a836b35f036ead102be8347103e8 (patch)
treeaa044a914be9cb01a5fff287b558f5ff95cb59cf /extra
parent0f89be721b820fe295cacfd5e3c875d3037b9874 (diff)
downloadfatcat-cli-260ae4ec7ee4a836b35f036ead102be8347103e8.tar.gz
fatcat-cli-260ae4ec7ee4a836b35f036ead102be8347103e8.zip
move around notes, docs, other text files
Diffstat (limited to 'extra')
-rw-r--r--extra/fatcat-cli.164
-rw-r--r--extra/fatcat-cli.1.scdoc48
2 files changed, 112 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
diff --git a/extra/fatcat-cli.1.scdoc b/extra/fatcat-cli.1.scdoc
new file mode 100644
index 0000000..6a176aa
--- /dev/null
+++ b/extra/fatcat-cli.1.scdoc
@@ -0,0 +1,48 @@
+fatcat-cli(1) "fatcat.wiki CLI Manual Page"
+
+# NAME
+
+fatcat-cli - something something
+
+# SYNOPSIS
+
+fatcat-cli [FLAGS] [OPTIONS] <SUBCOMMAND>
+
+Subcommands:
+
+ create
+ delete
+ edit
+ editgroup
+ get
+ help
+ search
+ status
+ update
+
+# DESCRIPTION
+
+# OPTIONS
+
+*-h, --help*
+ Prints help information
+
+*-V, --version*
+ Prints version information
+
+*-v, --verbose*
+ 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.
+
+*--api-host <api-host>* [env: FATCAT_API_HOST] [default: https://api.fatcat.wiki]
+
+*--api-token <api-token>* [env: FATCAT_API_AUTH_TOKEN]
+
+*--search-host <search-host>* [env: FATCAT_SEARCH_HOST] [default: https://search.fatcat.wiki]
+
+# EXAMPLES
+
+Some examples of usage will go here, like:
+
+ fatcat-cli get thing
+