skytool 0.1.0-pre.2

an experimental API client for BlueSky / ATProto
Documentation
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
crate::macros::spec! {
  com => {
    atproto => {
      identity => {
        #[command(long_about = "Describe the credentials that should be included in the DID doc of an account that is migrating to this service.")]
        getRecommendedDidCredentials => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.identity.get_recommended_did_credentials().await?))
              }
            }
          }
          output => { impl } => Output
        },
        #[command(long_about = "🔐 Request an email with a code to in order to request a signed PLC operation.")]
        requestPlcOperationSignature => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.identity.request_plc_operation_signature().await?))
              }
            }
          }
        },
        #[command(long_about = "📖 Resolves a handle (domain name) to a DID.")]
        resolveHandle => {
          input => {
            #[arg(long)]
            handle: bsky_sdk::api::types::string::Handle
          } => Parameters
          output => { impl } => Output
        },
        #[command(long_about = "Signs a PLC operation to update some value(s) in the requesting DID's document.")]
        signPlcOperation => {
          input => ( camino::Utf8PathBuf ) => Input
          output => { impl } => Output
        },
        #[command(long_about = "Validates a PLC operation to ensure that it doesn't violate a service's constraints or get the identity into a bad state, then submits it to the PLC registry.")]
        submitPlcOperation => {
          input => {
            #[arg(long, value_parser = crate::parse::unknown)]
            operation: bsky_sdk::api::types::Unknown
          } => Input
        },
        #[command(long_about = "🔐 [PDS] Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary.")]
        updateHandle => {
          input => {
            #[arg(long)]
            handle: bsky_sdk::api::types::string::Handle
          } => Input
        }
      },
      repo => {
        #[command(long_about = "🔐 [PDS] Create a single new repository record.")]
        createRecord => {
          input => {
            #[arg(long)]
            collection: bsky_sdk::api::types::string::Nsid,
            #[arg(long, value_parser = crate::parse::unknown)]
            record: bsky_sdk::api::types::Unknown,
            #[arg(long)]
            repo: bsky_sdk::api::types::string::AtIdentifier,
            #[arg(long)]
            rkey: Option<String>,
            #[arg(long)]
            swap_commit: Option<bsky_sdk::api::types::string::Cid>,
            #[arg(long)]
            validate: Option<bool>
          } => Input
          output => { impl } => Output
        },
        #[command(long_about = "🔐 [PDS] Delete a repository record, or ensure it doesn't exist.")]
        deleteRecord => {
          input => {
            #[arg(long)]
            collection: bsky_sdk::api::types::string::Nsid,
            #[arg(long)]
            repo: bsky_sdk::api::types::string::AtIdentifier,
            #[arg(long)]
            rkey: String,
            #[arg(long)]
            swap_commit: Option<bsky_sdk::api::types::string::Cid>,
            #[arg(long)]
            swap_record: Option<bsky_sdk::api::types::string::Cid>
          } => Input
          output => { impl } => Output
        },
        #[command(long_about = "📖 Get information about an account and repository, including the list of collections.")]
        describeRepo => {
          input => {
            #[arg(long)]
            repo: bsky_sdk::api::types::string::AtIdentifier
          } => Parameters
          output => { impl } => Output
        },
        #[command(long_about = "📖 Get a single record from a repository.")]
        getRecord => {
          input => {
            #[arg(long)]
            cid: Option<bsky_sdk::api::types::string::Cid>,
            #[arg(long)]
            collection: bsky_sdk::api::types::string::Nsid,
            #[arg(long)]
            repo: bsky_sdk::api::types::string::AtIdentifier,
            #[arg(long)]
            rkey: String
          } => Parameters
          output => { impl } => Output
        },
        #[command(long_about = "📖 List a range of records in a repository, matching a specific collection.")]
        listRecords => {
          input => {
            #[arg(long)]
            collection: bsky_sdk::api::types::string::Nsid,
            #[arg(long)]
            cursor: Option<String>,
            #[arg(long, value_parser = crate::parse::limited_non_zero_u8::<100>)]
            limit: Option<bsky_sdk::api::types::LimitedNonZeroU8<100>>,
            #[arg(long)]
            repo: bsky_sdk::api::types::string::AtIdentifier,
            #[arg(long)]
            reverse: Option<bool>,
            #[arg(long)]
            rkey_end: Option<String>,
            #[arg(long)]
            rkey_start: Option<String>
          } => Parameters
          output => { impl } => Output
        },
        #[command(long_about = "🔐 [PDS] Write a repository record, creating or updating it as needed.")]
        putRecord => {
          input => {
            #[arg(long)]
            collection: bsky_sdk::api::types::string::Nsid,
            #[arg(long, value_parser = crate::parse::unknown)]
            record: bsky_sdk::api::types::Unknown,
            #[arg(long)]
            repo: bsky_sdk::api::types::string::AtIdentifier,
            #[arg(long)]
            rkey: String,
            #[arg(long)]
            swap_commit: Option<bsky_sdk::api::types::string::Cid>,
            #[arg(long)]
            swap_record: Option<bsky_sdk::api::types::string::Cid>,
            #[arg(long)]
            validate: Option<bool>
          } => Input
          output => { impl } => Output
        }
      },
      server => {
        #[command(long_about = "Activates a currently deactivated account. Used to finalize account migration after the account's repo is imported and identity is setup.")]
        activateAccount => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.server.activate_account().await?))
              }
            }
          }
        },
        #[command(long_about = "🔐 Returns the status of an account, especially as pertaining to import or recovery.")]
        checkAccountStatus => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.server.check_account_status().await?))
              }
            }
          }
          output => { impl } => Output
        },
        #[command(long_about = "Confirm an email using a token from com.atproto.server.requestEmailConfirmation.")]
        confirmEmail => {
          input => {
            #[arg(long)]
            email: String,
            #[arg(long)]
            token: String
          } => Input
        },
        #[command(long_about = "[PDS] Create an account.")]
        createAccount => {
          input => {
            #[arg(long)]
            did: Option<bsky_sdk::api::types::string::Did>,
            #[arg(long)]
            email: Option<String>,
            #[arg(long)]
            handle: bsky_sdk::api::types::string::Handle,
            #[arg(long)]
            invite_code: Option<String>,
            #[arg(long)]
            password: Option<String>,
            #[arg(long, value_parser = crate::parse::unknown)]
            plc_op: Option<bsky_sdk::api::types::Unknown>,
            #[arg(long)]
            recovery_key: Option<String>,
            #[arg(long)]
            verification_code: Option<String>,
            #[arg(long)]
            verification_phone: Option<String>
          } => Input
          output => { impl } => Output
        },
        #[command(long_about = "Create an App Password.")]
        createAppPassword => {
          input => {
            #[arg(long)]
            name: String,
            #[arg(long)]
            privileged: Option<bool>
          } => Input
          output => { impl } => Output
        },
        #[command(long_about = "Create an invite code.")]
        createInviteCode => {
          input => {
            #[arg(long, value_name = "DID")]
            for_account: Option<bsky_sdk::api::types::string::Did>,
            #[arg(long, value_name = "INTEGER")]
            use_count: i64
          } => Input
          output => { impl } => Output
        },
        #[command(long_about = "Create invite codes.")]
        createInviteCodes => {
          input => {
            #[arg(long, value_name = "INTEGER", default_value = "1")]
            code_count: i64,
            #[arg(long = "for-account", value_name = "DID")]
            for_accounts: Option<Vec<bsky_sdk::api::types::string::Did>>,
            #[arg(long, value_name = "INTEGER")]
            use_count: i64
          } => Input
          output => { impl } => Output
        },
        #[command(long_about = "🔑 Create an authentication session.")]
        createSession => {
          input => {
            #[arg(long)]
            auth_factor_token: Option<String>,
            #[arg(long)]
            identifier: String,
            #[arg(long)]
            password: String
          } => Input
          output => { impl } => Output
        },
        #[command(long_about = "Deactivates a currently active account.")]
        deactivateAccount => {
          input => {
            #[arg(long)]
            delete_after: Option<bsky_sdk::api::types::string::Datetime>
          } => Input
        },
        #[command(long_about = "🔐 Delete an actor's account with a token and password.")]
        deleteAccount => {
          input => {
            #[arg(long)]
            did: bsky_sdk::api::types::string::Did,
            #[arg(long)]
            password: String,
            #[arg(long)]
            token: String
          } => Input
        },
        #[command(long_about = "🔐 Delete the current session.")]
        deleteSession => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.server.delete_session().await?))
              }
            }
          }
        },
        #[command(long_about = "[PDS] Describes the server's account creation requirements and capabilities.")]
        describeServer => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.server.describe_server().await?))
              }
            }
          }
          output => { impl } => Output
        },
        #[command(long_about = "🔐 Get all invite codes for the current account.")]
        getAccountInviteCodes => {
          input => {
            #[arg(long = "no-create-available", action = clap::ArgAction::SetFalse)]
            create_available: Option<bool>,
            #[arg(long = "no-include-used", action = clap::ArgAction::SetFalse)]
            include_used: Option<bool>
          } => Parameters
          output => { impl } => Output
        },
        #[command(long_about = "Get a signed token on behalf of the requesting DID for the requested service.")]
        getServiceAuth => {
          input => {
            #[arg(long, value_name = "DID")]
            aud: bsky_sdk::api::types::string::Did,
            #[arg(long, value_name = "INTEGER")]
            exp: Option<i64>,
            #[arg(long, value_name = "NSID")]
            lxm: Option<bsky_sdk::api::types::string::Nsid>
          } => Parameters
          output => { impl } => Output
        },
        #[command(long_about = "🔐 Get information about the current auth session.")]
        getSession => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.server.get_session().await?))
              }
            }
          }
          output => { impl } => Output
        },
        #[command(long_about = "List all App Passwords.")]
        listAppPasswords => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.server.list_app_passwords().await?))
              }
            }
          }
          output => { impl } => Output
        },
        #[command(long_about = "🗝️ Refresh an authentication session.")]
        refreshSession => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.server.refresh_session().await?))
              }
            }
          }
          output => { impl } => Output
        },
        #[command(long_about = "Initiate a user account deletion via email.")]
        requestAccountDelete => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.server.request_account_delete().await?))
              }
            }
          }
        },
        #[command(long_about = "Request an email with a code to confirm ownership of email.")]
        requestEmailConfirmation => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.server.request_email_confirmation().await?))
              }
            }
          }
        },
        #[command(long_about = "Request a token in order to update email.")]
        requestEmailUpdate => {
          custom => {
            struct => {}
            impl => {
              pub(crate) async fn with(self, agent: &bsky_sdk::BskyAgent) -> Result<Box<dyn crate::Output>, Error> {
                Ok(Box::new(agent.api.com.atproto.server.request_email_update().await?))
              }
            }
          }
          output => { impl } => Output
        },
        #[command(long_about = "Initiate a user account password reset via email.")]
        requestPasswordReset => {
          input => {
            #[arg(long)]
            email: String
          } => Input
        },
        #[command(long_about = "📖 Reserve a repo signing key, for use with account creation.")]
        reserveSigningKey => {
          input => {
            #[arg(long, value_name = "DID")]
            did: Option<bsky_sdk::api::types::string::Did>
          } => Input
          output => { impl } => Output
        },
        #[command(long_about = "Reset a user account password using a token.")]
        resetPassword => {
          input => {
            #[arg(long)]
            password: String,
            #[arg(long)]
            token: String
          } => Input
        },
        #[command(long_about = "Revoke an App Password by name.")]
        revokeAppPassword => {
          input => {
            #[arg(long)]
            name: String
          } => Input
        },
        #[command(long_about = "Update an account's email.")]
        updateEmail => {
          input => {
            #[arg(long)]
            email: String,
            #[arg(long)]
            email_auth_factor: Option<bool>,
            #[arg(long)]
            token: Option<String>
          } => Input
        }
      }
    }
  }
}