diff options
author | bryan newbold <bnewbold@robocracy.org> | 2023-03-04 16:48:20 -0800 |
---|---|---|
committer | bryan newbold <bnewbold@robocracy.org> | 2023-03-04 16:48:20 -0800 |
commit | a16558ed05428661936c317c0da15bd07eeaaba1 (patch) | |
tree | 45e145f727b8accab2e3a4582d8d475fb0abc0f1 /extra/adenosine.1 | |
parent | 6c44f0ee841fe1bf84a8a299e0bf78a01e84f03a (diff) | |
download | adenosine-a16558ed05428661936c317c0da15bd07eeaaba1.tar.gz adenosine-a16558ed05428661936c317c0da15bd07eeaaba1.zip |
cli: ATP_PDS_HOST as env var
Diffstat (limited to 'extra/adenosine.1')
-rw-r--r-- | extra/adenosine.1 | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/extra/adenosine.1 b/extra/adenosine.1 index 24ebdb2..060977e 100644 --- a/extra/adenosine.1 +++ b/extra/adenosine.1 @@ -1,11 +1,11 @@ -.\" Generated by scdoc 1.11.1 +.\" Generated by scdoc 1.11.2 .\" Complete documentation for this program is not available as a GNU info page .ie \n(.g .ds Aq \(aq .el .ds Aq ' .nh .ad l .\" Begin generated content: -.TH "adenosine" "1" "2022-11-07" "adenosine CLI Client Manual Page" +.TH "adenosine" "1" "2023-03-05" "adenosine CLI Client Manual Page" .P .SH NAME .P @@ -34,7 +34,7 @@ Lexicon (bsky.\&app) is partially supported with helper commands.\& .P Several commands accept generic key/value fields which are passed through as either query parameters or combined together in to a request body JSON object.\& -Escaping and other corner-cases aren't handled.\& +Escaping and other corner-cases aren'\&t handled.\& .P \fB==\fR .RS 4 @@ -46,7 +46,7 @@ Query parameter.\& Key and Value both passed as strings.\& Body fields, combined together as a JSON object.\& Keys are strings, values are parsed as JSON with fall-through to string type.\& .P .RE -For example, the argument list \fBlimit==25 title="regarding documentation" year=2022 tags='["blue", "green"]'\fR +For example, the argument list \fBlimit==25 title="regarding documentation" year=2022 tags='\&["blue", "green"]'\&\fR would be interpreted as a single query parameter "limit" with value "25", and a JSON object with keys "title" (string value), "year" (number value), "tags" (array of strings).\& @@ -112,12 +112,12 @@ Fetch the home feed, or account feed for a specific user .RE \fBbsky follow\fR .RS 4 -Create a 'follow' record for the target by AT URI +Create a '\&follow'\& record for the target by AT URI .P .RE \fBbsky like\fR .RS 4 -Create a 'like' record for the target by AT URI +Create a '\&like'\& record for the target by AT URI .P .RE \fBbsky notifications\fR @@ -127,7 +127,7 @@ Fetch notification feed .RE \fBbsky post\fR .RS 4 -Create a new 'post' record +Create a new '\&post'\& record .P .RE \fBbsky profile\fR @@ -137,7 +137,7 @@ Display a profile record (or self if not provided) .RE \fBbsky repost\fR .RS 4 -Create a 'repost' record for the target by AT URI +Create a '\&repost'\& record for the target by AT URI .P .RE \fBbsky search-users\fR @@ -179,7 +179,7 @@ Read raw binary repository as CAR format from stdin, and import to PDS .RE \fBrepo root [did]\fR .RS 4 -Get the current 'root' commit for a DID +Get the current '\&root'\& commit for a DID .P .RE .SH OPTIONS @@ -197,23 +197,23 @@ Prints version information \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.\& +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--host <atp-host>\fR [env: ATP_HOST] +\fB--pds-host <atp-host>\fR [env: ATP_PDS_HOST] .P \fB--auth-token <auth-token>\fR [env: ATP_AUTH_TOKEN] .P .SH GETTING STARTED .P -To start interacting with a PDS, set the `ATP_HOST` environment variable.\& Then +To start interacting with a PDS, set the `ATP_PDS_HOST` environment variable.\& Then either register a test account, or create a new session for an existing account, and save the JWT token to the `ATP_AUTH_TOKEN`: .P .nf .RS 4 # default port for bluesky-social/atproto implementation -export ATP_HOST=http://localhost:2583 +export ATP_PDS_HOST=http://localhost:2583 # register a new account adenosine account register -u voltaire\&.test -p bogus -e voltaire@example\&.com @@ -240,8 +240,8 @@ export ATP_AUTH_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9\&.eyJzdWIiOiJkaWQ6cGx .fi .RE .P -You could save the `ATP_HOST` and `ATP_AUTH_TOKEN` values in `~/.\&bashrc` so you -don't need to enter them every time.\& +You could save the `ATP_PDS_HOST` and `ATP_AUTH_TOKEN` values in `~/.\&bashrc` so you +don'\&t need to enter them every time.\& .P Now you can start posting and poking around: .P |