- bap_resolveDID was renamed to bap_getDID. It also no longer calls to a resolve server in favor of resolving the handle itself. (DNS and HTTPS are performed in that order)
- bap_getKeys no longer uses $savedPDS. It instead opts to resolve the PDS from the specified identifier, or from the third parameter (new!).
- bap_getKeys and bap_refreshKeys now load data from the obtained JWT after a successful login/refresh. It is unnecessary to manually manage $savedDID now. $savedPDS is only needed when working with an account on a PDS that isn't it's "blessed" one.
- bap_findPDS has been removed as it is unnecessary with the bap_getKeys changes.
- bap_postToBluesky was removed. Use bapBsky_createPost with bap-bsky.sh instead.
- $bap_dryRun variable was added. Set it to 1 to see all records that would normally be posted.
- bap_resolveDID (the new one) was split from bap_resolvePDS, and it prints the DID doc.
- The check to see if the account is active in bap_getKeys and bap_refreshKeys can be skipped by setting $bap_disableOptionalChecks to 1.
- bap_generateDatetime to get an atproto datetime of the current date and time
- bap_postRecord can set rkey and whether to validate the record against the lexicon
- bap_getDID now verifies the DID exists if it was manually specified
- bap_prepareImage now uses exiftool instead of imagemagick for calculating dimensions. It should be able to process videos under certain conditions.
- bash-atproto now depends on dig.
- Fixed issue with generating datetimes on non-GNU systems (Closes #5)

bap-bsky v2 changes:
- Removed bapBsky_cyorAddLabel as it has been replaced by bapBsky_cyorAddSelfLabels
- bapBsky_prepareVideo was renamed to bapBsky_prepareVideoIndirect, now only accepts mp4 videos, and scrubs metadata
- Removed compatibility stubs
- CYOR commands that fetch posts now require login. They also now respect threadgates and won't work if there's a block relationship.
- bapBsky_cyorGetReplyRoot was renamed to bapBskyInternal_cyorGetReplyRoot and now always runs after bapBsky_cyorAddReply
- bap-bsky now calls the AppView API set in bapBsky_bskyAppViewDID (default Bluesky) for some requests
- bapBsky_getPost fetches a Bluesky post with auth
- bapBsky_getProfile fetches a Bluesky profile with auth
- bapBsky_verifyActor creates a verification record
- bapBsky_followActor follows an actor or ensures an actor is being followed
- bapBsky_likePost likes a post or ensures it has been liked (does not use via yet)
- bapBsky_submitPost now passes through arguments for the bap_postRecord changes
- createdAt is no longer added automatically if already present in the record
- Now uses bap_generateDatetime

bap-extra v2 changes:
- New bapExt_bskyCancelActor which creates an app.bsky.graph.cancellation record (see cred.blue/canceler)
- Removed bapExt_fastLogin as bap_getKeys acts like it now
- bapExt_checkDeps now checks for dig

bap-sprk v2.1 changes:
- Now uses bap_generateDatetime
- bapSprk_submitPost now passes through arguments for the bap_postRecord changes
- bapSprk_cyorAddReply can make the post being worked on a reply

a8acdc7d

Engielolz

4 months ago

branches 3

bap4 1 month ago

main 7 months ago default

compare

gitversion 8 months ago

compare

README.md

bash-atproto#

bash-atproto is a bare-bones atproto client/library that I wrote for imasimgbot and the now-defunct 765coverbot. It is a Bash script that uses cURL to authenticate, create records and upload blobs.

Supported functions#

Functions built into bash-atproto.sh

Fetch a record from URI - bap_getRecord
Resolving a handle to did:plc/did:web - bap_getDID
Resolving the DID doc for a DID - bap_resolveDID
Resolving a handle from a DID - bap_resolveHandle
Resolving an account's PDS from the DID - bap_resolvePDS
Creating and closing sessions on the PDS - bap_getKeys and bap_closeSession
Saving and loading a secrets file (contains your access and refresh tokens) - bap_saveSecrets and bap_loadSecrets
Extracting account and token information from the access token - (automatic)
Refreshing tokens - bap_refreshKeys
Minting service auth tokens - bap_getServiceAuth
Prepare an image, stripping EXIF data and (if needed) resizing it for a set file size and dimensions - bap_prepareImage
Uploading blobs - bap_uploadBlobToPDS
Working with records:
- Add string value - bapCYOR_str
- Add value - bapCYOR_add
- Add to array - bapCYOR_arr
- Remove key - bapCYOR_rem
- Post record - bap_postRecord

Bluesky functions#

With bap-bsky.sh

Creating basic Bluesky text post records - bapBsky_createPost
Creating Bluesky repost records - bapBsky_createRepost
Preparing an image for Bluesky (including resizing and compressing) - bapBsky_prepareImage
Creating a post with a single embedded image or video with alt text and embedded image dimensions - bapBsky_postImage and bapBsky_postVideo
When working on a post:
- Start a post - bapBsky_cyorInit
- Prepare an image for upload - bapBsky_prepareImage
- Add an image - bapBsky_cyorAddImage
- Add a video - bapBsky_cyorAddVideo
- Add an embed - bapBsky_cyorAddExternalEmbed
- Set language - bapBsky_cyorAddLangs
- Add tags - bapBsky_cyorAddTags
- Add self-labels - bapBsky_cyorAddSelfLabels
- Make reply - bapBsky_cyorAddReply
- Make quote - bapBsky_cyorAddQuote
- Submit post - bapBsky_submitPost

Spark functions#

With the experimental bap-sprk.sh

Creating a post with a single embedded image with alt text or video - bapSprk_postImage and bapSprk_postVideo
When working on a post:
- Start a post - bapSprk_cyorInit
- Prepare an image for upload - bapSprk_prepareImage
- Add an image - bapSprk_cyorAddImage
- Add a video - bapSprk_cyorAddVideo
- Submit post - bapSprk_submitPost

Dependencies#

bash-atproto requires curl 7.76 or later, jq 1.7 or later and dig. Posting images and video additionally requires imagemagick, exiftool, uuidgen and file.

Basic usage#

bash-atproto is loaded with source bash-atproto.sh. From there, most operations will require you to sign-in to an atproto account, which can be done in one function:

bap_getKeys <did or handle> <password>

The access and refresh tokens are saved in memory and can be written to disk with bap_saveSecrets <file>. It is recommended you use an App Password to log in rather than a normal password.

You may need to load additional scripts to handle other tasks. For example, to post to Bluesky, you will need to source bap-bsky.sh.

If bash-atproto is being used with a bot or other service that runs periodically, the calling application should implement a timer to refresh tokens. bash-atproto provides a function to perform a refresh (bap_refreshKeys) and a timestamp to detect when a token refresh should be performed ($bap_savedAccessExpiry), but it does not do so itself.

Standalone usage#

bash-atproto is mainly meant for use as a component for bash scripts that want to use the AT Protocol, but it by itself can be used as a simple atproto client for the command line. The following commands will log in to your PDS, create a Bluesky post and then log out:

source bash-atproto.sh
source bap-bsky.sh
bap_getKeys <your did or handle> <app password>
bapBsky_createPost "Hello, World!" en
bap_closeSession

License#

bash-atproto is licensed under the MIT License. Please note that bash-atproto is hobbyist-grade software and I take no responsibility if it is used to post Discourse™ to your account.

Clone this repository