ocaml-atp#

OCaml libraries and CLI tools for the AT Protocol, the decentralized social networking protocol powering Bluesky and other applications.

Status#

This is a work in progress, but functional enough for personal use. The core libraries implement AT Protocol primitives, and CLI tools for Bluesky, Tangled, and Standard.Site are included.

Significant inspiration (and some code such as Hermes for RPC and the MST) came from futur.blue/pegasus which has a more complete PDS implementation. The appropriate MPL license has been preserved where that code is used.

Installation#

Install with opam:

$ opam install atp bsky tangled standard-site

If opam cannot find the packages, they may not yet be released in the public opam-repository. Add the overlay repository, then install them:

$ opam repo add samoht https://tangled.org/gazagnaire.org/opam-overlay.git
$ opam update
$ opam install atp bsky tangled standard-site

The upstream aoah overlay can also be used:

$ opam repo add aoah https://tangled.org/anil.recoil.org/aoah-opam-repo.git
$ opam install atp bsky tangled standard-site

Or pin directly from git:

$ opam pin add -y https://tangled.org/@anil.recoil.org/ocaml-atp.git

Packages#

Core Libraries#

Package	Description
`atp`	IPLD implementation with CID, DAG-CBOR, MST, CAR format support
`atp-xrpc`	XRPC client for AT Protocol PDS communication
`atp-xrpc-server`	XRPC HTTP server for AT Protocol
`xrpc-auth`	Authentication helpers for CLI applications

Code Generation#

Package	Description
`hermest`	Lexicon code generator for OCaml
`hermest-cli`	CLI for the hermest generator

Generated Lexicon Libraries#

Package	Description
`atp-lexicon-atproto`	`com.atproto.*` types
`atp-lexicon-bsky`	`app.bsky.*` types (Bluesky)
`atp-lexicon-tangled`	`sh.tangled.*` types
`atp-lexicon-standard-site`	`site.standard.*` types

Application Libraries and CLIs#

Package	Description
`bsky`	Bluesky client library and CLI
`tangled`	Tangled git collaboration platform client and CLI
`standard-site`	Blog/publication management client and CLI

Requirements#

OCaml >= 5.1
Dune >= 3.20

Usage#

Bluesky CLI#

$ # Login (credentials stored in XDG config directory)
$ bsky login

$ # Post to your timeline
$ bsky post "Hello from OCaml!"

$ # View your timeline
$ bsky timeline

Tangled CLI#

$ # Login
$ tangled login

$ # List repositories
$ tangled repos

Standard Site CLI#

$ # Login
$ standard-site login

$ # Manage your blog posts
$ standard-site posts list

Building from Source#

$ git clone https://tangled.org/@anil.recoil.org/ocaml-atp.git
$ cd ocaml-atp
$ opam install . --deps-only
$ dune build

Licence#

ISC + MPL for bits from Pegasus

Configure Feed