1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
NAME
====
adenosine - command-line client for AT protocol (atproto.com)
SYNOPSIS
========
adenosine \[OPTIONS\] \<COMMAND\> \<ARGS\>
DESCRIPTION
===========
This is a simple, enthusiast-grade CLI client for the work-in-progress
AT Protocol (atproto.com). It is an entirely \"delegated\" client, which
means that it does not store or cache any user content locally;
everything works by making HTTP/XRPC requests to a Personal Data Server
(PDS), which is usually a remote service.
The only real utility of this tool currently is messing around with
prototype implementations, possibly while developing them.
This client does not currently do any schema validation of Lexicons,
either at compile time or runtime (eg, dynamically fetching Lexicons).
The Bluesky Lexicon (bsky.app) is partially supported with helper
commands.
FIELD SYNTAX
============
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.
**==**
> 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.
For example, the argument list **limit==25 title=\"regarding
documentation\" year=2022 tags=\'\[\"blue\", \"green\"\]\'** 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).
COMMANDS
========
**status**
> Summarizes configuration, and (TODO) connection and authentication to
> the API server. Useful for debugging.
**describe** \[name\]
> Prints repository description fetched from PDS
**resolve** \<name\>
> Has PDS resolve username to a DID
Generic XRPC Requests
---------------------
It is possible to construct and submit a generic XRPC request to the
PDS, and prints any response.See field syntax section above about query
parameters and body fields. Body fields only used for \"post\" requests.
**xrpc** \<\"get\"\|\"post\"\> \<nsid\> \[fields\]+
Generic Record Interaction
--------------------------
**ls** \<at-uri\>
> List either collections under a repository, or records under a
> collection
**get** \<at-uri\>
> Fetch and print a single record
**create** \<collection\> \[fields\]\...
> Construct and create a generic record, printing the resulting AT-URI
> and CID
**update** \<at-uri\> \[fields\]\...
> Fetch record, update fields, \"put\" back to same record path
**delete** \<at-uri\>
> Delete a single record from repository
Bluesky (bsky.app)
------------------
**bsky feed**
> Fetch the home feed, or account feed for a specific user
**bsky follow**
> Create a \'follow\' record for the target by AT URI
**bsky like**
> Create a \'like\' record for the target by AT URI
**bsky notifications**
> Fetch notification feed
**bsky post**
> Create a new \'post\' record
**bsky profile**
> Display a profile record (or self if not provided)
**bsky repost**
> Create a \'repost\' record for the target by AT URI
**bsky search-users**
> Query by partial username
Account Management
------------------
**account register \--email \<email\> \--password \<password\>
\--username \<username\>**
**account info**
> Fetches account metadata for the current session
**account login \--password \<password\> \--username \<username\>**
> Create a new authenticated session
**account logout**
> Deletes the current login session
Raw Repository Management
-------------------------
**repo export \[did\]**
> Dump raw binary repository as CAR format to stdout
**repo import \[did\]**
> Read raw binary repository as CAR format from stdin, and import to PDS
**repo root \[did\]**
> Get the current \'root\' commit for a DID
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.
**\--host \<atp-host\>** \[env: ATP\_HOST\]
**\--auth-token \<auth-token\>** \[env: ATP\_AUTH\_TOKEN\]
GETTING STARTED
===============
To start interacting with a PDS, set the \`ATP\_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\`:
# default port for bluesky-social/atproto implementation
export ATP_HOST=http://localhost:2583
# register a new account
adenosine account register -u voltaire.test -p bogus -e voltaire@example.com
{
"did": "did:plc:yqtuksvatmmgngd5nkkw75hn",
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6cGxjOnlxdHVrc3ZhdG1tZ25nZDVua2t3NzVobiIsImlhdCI6MTY2Njk5NjMwNn0.MMQa4JIQdwvhy-rjJ0kO-z8-KdoOL0Lto9JtOkK-lwE",
"username": "voltaire.test"
}
export ATP_AUTH_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6cGxjOnlxdHVrc3ZhdG1tZ25nZDVua2t3NzVobiIsImlhdCI6MTY2Njk5NjMwNn0.MMQa4JIQdwvhy-rjJ0kO-z8-KdoOL0Lto9JtOkK-lwE
# to clear the auth token env variable
unset ATP_AUTH_TOKEN
# create a new session (login) for existing account
adenosine account login -u voltaire.test -p bogus
{
"did": "did:plc:yqtuksvatmmgngd5nkkw75hn",
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6cGxjOnlxdHVrc3ZhdG1tZ25nZDVua2t3NzVobiIsImlhdCI6MTY2Njk5NjQxNX0.j2wcF1g9NxT_1AvYRiplNf_jtK6S81y3L38AkcBwOqY",
"name": "voltaire.test"
}
export ATP_AUTH_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6cGxjOnlxdHVrc3ZhdG1tZ25nZDVua2t3NzVobiIsImlhdCI6MTY2Njk5NjQxNX0.j2wcF1g9NxT_1AvYRiplNf_jtK6S81y3L38AkcBwOqY
You could save the \`ATP\_HOST\` and \`ATP\_AUTH\_TOKEN\` values in
\`\~/.bashrc\` so you don\'t need to enter them every time.
Now you can start posting and poking around:
adenosine bsky post "gruel again for breakfast"
{
"cid": "bafyreig2aqlsg4arslck64wbo2hnhe6k2a4z3z2sjfzh3uapv3a4zjld7e",
"uri": "at://did:plc:yqtuksvatmmgngd5nkkw75hn/app.bsky.post/3jg5zkr322c2a"
}
adenosine ls at://voltaire.test
app.bsky.post
|
