Repository files navigation

A lightweight, fast, universal and typed Bluesky API wrapper for Apps & Bots.

tsky is still in active development and is not ready for production use. If you want to contribute to the project, please read theCONTRIBUTING.md file or join ourDiscord Server.

tsky is a lightweight, fast, universal and typed Bluesky API wrapper for Apps & Bots. It's designed to be easy to use, lightweight and straightforward to use. It's built with TypeScript and has full type support.

It was primarily built for theNimbus Client but can be used in any other project that requires Bluesky API integration.

# NPMnpm install tsky# Yarnyarn add tsky# PNPMpnpm add tsky# Bunbun add tsky

Using a Public Agent

import{createAgent}from'@tsky/client';constagent=awaitcreateAgent({options:{service:'https://public.api.bsky.app',},});// Getting a user from their handle// First, we need to get the user's DIDconstdid=awaitagent.resolveDIDFromHandle(handle);// Then, we can get the user's profileconstprofile=awaitagent.actor(did);

Using an Authenticated Agent

import{createAgent}from'@tsky/client';constagent=awaitcreateAgent({credentials:{identifier:"handle",password:"password"}});// Getting the profile of the authenticated userconstuser_profile=awaitagent.user.profile();

• 📚 tsky Documentation
• 🦋 tsky on Bluesky
• 📣 tsky Discord Server
• 🦋 Nimbus on Bluesky

If you want to contribute to this project, please read theCONTRIBUTING.md file.

This project is licensed under the MIT License - see theLICENSE file for details.