atproto copied to clipboard
Social networking technology created by Bluesky
AT Protocol Reference Implementation (TypeScript)
This repository contains Bluesky's reference implementation of AT Protocol, and of the
app.bsky microblogging application service backend.
What is in here?
pds: "Personal Data Server", hosting repo content for atproto accounts. Most implementation code in
packages/pds, with runtime wrapper in
services/pds. See bluesky-social/pds for directions on self-hosting in the federation sandbox network.
bsky: AppView implementation of the
app.bsky.*API endpoints. Running on main network at
api.bsky.app. Most implementation code in
packages/bsky, with runtime wrapper in
Lexicons: for both the
app.bsky.* are canonically versioned in this repo, for now, under
./lexicons/. These are JSON files in the Lexicon schema definition language, similar to JSON Schema or OpenAPI.
Interoperability Test Data: the language-neutral test files in
./interop-test-files/ may be useful for other protocol implementations to ensure that they follow the specification correctly
The source code for the Bluesky Social client app (for web and mobile) can be found at bluesky-social/social-app.
Go programming language source code is in bluesky-social/indigo, including the BGS implementation.
nvm for managing Node.js installs. This project requires Node.js version 18.
pnpm is used to manage the workspace of multiple packages. You can install it with
npm install --global pnpm.
There is a Makefile which can help with basic development tasks:
# use existing nvm to install node 18 and pnpm
# pull dependencies and build all local packages
# run the tests, using Docker services as needed
# run a local PDS and AppView with fake test accounts and data
# (this requires a global installation of `jq` and `docker`)
# show all other commands
About AT Protocol
The Authenticated Transfer Protocol ("ATP" or "atproto") is a decentralized social media protocol, developed by Bluesky PBC. Learn more at:
- Overview and Guides 👈 Best starting point
- Github Discussions 👈 Great place to ask questions
- Protocol Specifications
- Blogpost on self-authenticating data structures
The Bluesky Social application encompasses a set of schemas and APIs built in the overall AT Protocol framework. The namespace for these "Lexicons" is
While we do accept contributions, we prioritize high quality issues and pull requests. Adhering to the below guidelines will ensure a more timely review.
- We may not respond to your issue or PR.
- We may close an issue or PR without much feedback.
- We may lock discussions or contributions if our attention is getting DDOSed.
- We do not provide support for build issues.
- Check for existing issues before filing a new one, please.
- Open an issue and give some time for discussion before submitting a PR.
- If submitting a PR that includes a lexicon change, please get sign off on the lexicon change before doing the implementation.
- Issues are for bugs & feature requests related to the TypeScript implementation of atproto and related services.
- Stay away from PRs that:
- Refactor large parts of the codebase
- Add entirely new features without prior discussion
- Change the tooling or frameworks used without prior discussion
- Introduce new unnecessary dependencies
Remember, we serve a wide community of users. Our day-to-day involves us constantly asking "which top priority is our top priority." If you submit well-written PRs that solve problems concisely, that's an awesome contribution. Otherwise, as much as we'd love to accept your ideas and contributions, we really don't have the bandwidth.
Are you a developer interested in building on atproto?
Bluesky is an open social network built on the AT Protocol, a flexible technology that will never lock developers out of the ecosystems that they help build. With atproto, third-party can be as seamless as first-party through custom feeds, federated services, clients, and more.
If you're a developer interested in building on atproto, we'd love to email you a Bluesky invite code. Simply share your GitHub (or similar) profile with us via this form.
This project is dual-licensed under MIT and Apache 2.0 terms:
- MIT license (LICENSE-MIT.txt or http://opensource.org/licenses/MIT)
- Apache License, Version 2.0, (LICENSE-APACHE.txt or http://www.apache.org/licenses/LICENSE-2.0)
Downstream projects and end users may chose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.