Simple bluesky client
Project description
🐦 ssky - Simple Bluesky Client
A lightweight, command-line Bluesky client that makes it easy to interact with the Bluesky social network from your terminal.
✨ Features
- 🔑 Simple authentication and session management
- 📝 Post, reply, quote, and repost content
- 🔍 Search posts and users
- 👥 Follow/unfollow users
- 📊 View timelines and profiles
- 🖼️ Support for images and link cards
- 📦 Linux shell friendly output formats
🚀 Quick Start
Installation
pip install ssky
Login
ssky login your-handle.bsky.social:your-password
Or set credentials via environment variable:
export SSKY_USER=your-handle.bsky.social:your-password
📖 Basic Usage
Posting
# Simple post
ssky post "Hello, Bluesky!"
# Post with images
ssky post "Check out these photos!" --image photo1.jpg --image photo2.jpg
# Reply to a post
ssky post "Great post!" --reply-to at://did:plc:.../app.bsky.feed.post/...
# Quote a post
ssky post "Interesting!" --quote at://did:plc:.../app.bsky.feed.post/...
Reading
# View your timeline
ssky get
# View your timeline with full threads
ssky get --thread
# Get specific post with its thread
ssky get at://did:plc:.../app.bsky.feed.post/... --thread
# Get user's posts as threads with custom depth
ssky get user.bsky.social --thread --thread-depth 5 --thread-parent-height 2
# View someone's profile
ssky profile user.bsky.social
# Search posts
ssky search "keyword"
# Search users
ssky user "username"
Social Actions
# Follow a user
ssky follow user.bsky.social
# Repost a post
ssky repost at://did:plc:.../app.bsky.feed.post/...
# Delete a post
ssky delete at://did:plc:.../app.bsky.feed.post/...
🔧 Advanced Usage
Thread Retrieval
Retrieve posts along with their complete conversation threads:
# Get timeline with full threads (each post expanded to its thread)
ssky get --thread
# Get specific post's thread
ssky get at://did:plc:.../app.bsky.feed.post/... --thread
# Get user's posts as threads
ssky get user.bsky.social --thread
# Control thread depth (default: 10 replies deep)
ssky get --thread --thread-depth 5
# Include parent posts (default: 0 parents)
ssky get --thread --thread-parent-height 2
# Save threads to files
ssky get --thread --output ./threads
Thread Output Formatting:
- Short/ID format (
-S,-I): Reply lines prefixed with"| " - Long/Text format (
-L,-T): Posts within thread separated by"|", independent threads by"----------------" - JSON/simple-json: Cannot be used with
--thread(returns error)
Output Formats
# Get only post IDs
ssky get --id
# Get only text content
ssky get --text
# Get full JSON output
ssky get --json
# Get simplified JSON with facets metadata (ideal for programmatic access)
ssky get --simple-json
# Save posts to files
ssky get --output ./posts
Facets Metadata in Simple-JSON
The --simple-json format includes structured facets metadata for rich text features:
- links: URLs with byte positions and text
- mentions: User mentions with handles, DIDs, and byte positions
- tags: Hashtags with byte positions and text
Example output:
{
"status": "success",
"data": [{
"uri": "at://...",
"cid": "...",
"author": {
"did": "did:plc:...",
"handle": "user.bsky.social",
"display_name": "User Name",
"avatar": "https://..."
},
"text": "Check out https://example.com @user.bsky.social #bluesky",
"created_at": "2024-01-01T00:00:00.000Z",
"facets": {
"links": [
{
"url": "https://example.com",
"byte_start": 10,
"byte_end": 30,
"text": "https://example.com"
}
],
"mentions": [
{
"handle": "user.bsky.social",
"did": "did:plc:...",
"byte_start": 31,
"byte_end": 49,
"text": "@user.bsky.social"
}
],
"tags": [
{
"tag": "bluesky",
"byte_start": 50,
"byte_end": 58,
"text": "#bluesky"
}
]
}
}]
}
Useful Examples
# Reply to your last post
ssky post "Update!" --reply-to $(ssky get myself --limit 1 --id)
# Search your own posts
ssky search "keyword" --author myself
# Save your timeline to files
ssky get --output ./timeline
🤖 IDE Integration
Cursor Agent MCP Tools
ssky provides comprehensive MCP (Model Context Protocol) tools for seamless integration with Cursor Agent, enabling AI-powered Bluesky interactions directly in your development environment.
Features:
- 📋 10 comprehensive tools: Complete Bluesky functionality
- 🤖 AI-optimized: Long format defaults for better AI understanding
- 🔧 Full feature support: Posts with images, quotes, replies, search, social actions
- ⚡ Real-time integration: Direct Bluesky interaction from Cursor
Quick Setup:
# For new MCP setup: copy sample configuration (no build required!)
mkdir -p .cursor
cp mcp/mcp.sample.json .cursor/mcp.json
# Set your Bluesky credentials
export SSKY_USER=your-handle.bsky.social:your-password
# Restart Cursor to load the MCP tools
✨ Docker will automatically pull the pre-built image on first use!
Advanced Setup:
- For existing MCP setup: Add ssky server to your
.cursor/mcp.json(seemcp/mcp.sample.json) - For local development: Use
cd mcp && ./build.sh && cd ..to build locally - Complete guide: See MCP Documentation
Available Tools:
ssky_get,ssky_search,ssky_user,ssky_profile- Content retrievalssky_post- Content creation with images/quotes/repliesssky_follow,ssky_unfollow,ssky_repost,ssky_unrepost- Social actionsssky_delete- Content management
🧪 Development with Dev Container
For development using VS Code Dev Containers:
-
Copy the environment configuration file and set your Bluesky credentials:
cp .env.local.sample .env.local
Edit
.env.localand add your Bluesky handle and password:SSKY_USER=your-handle.bsky.social:your-password SSKY_SKIP_REAL_API_TESTS=1
-
The dev container automatically:
- Loads environment variables from
.env.local - Installs Claude Code extension
- Sets up Python 3.12 environment with Docker support
- Loads environment variables from
🧪 Testing
To run the tests in the tests/ directory:
-
Copy the environment configuration file and set your Bluesky credentials:
cp tests/_env tests/.env
Edit
tests/.envand add your Bluesky handle and password. -
Run tests using pytest:
# Run all tests pytest tests/ -v # Run individual feature tests pytest tests/test_login.py -v # Login functionality pytest tests/test_post_and_delete.py -v # Post and delete operations pytest tests/test_search.py -v # Search functionality pytest tests/test_follow_unfollow.py -v # Follow/unfollow operations pytest tests/test_get.py -v # Timeline retrieval pytest tests/test_profile.py -v # Profile display pytest tests/test_repost_unrepost.py -v # Repost/unrepost operations pytest tests/test_user.py -v # User functionality
📝 Requirements
- Python 3.12 or later
📜 License
👥 Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ssky-0.2.8.tar.gz.
File metadata
- Download URL: ssky-0.2.8.tar.gz
- Upload date:
- Size: 33.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.12.12 Linux/6.11.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e3405b1425b10d0931061ac6a3088aa3d482ef26cfd0ba5814843dfc6d877af6
|
|
| MD5 |
f5ce27d2ae2b83017d2dff2f8c6e759d
|
|
| BLAKE2b-256 |
81ee831e87c88bc08d483482e90aa917862106ebd59f8260215c3af331c25ef0
|
File details
Details for the file ssky-0.2.8-py3-none-any.whl.
File metadata
- Download URL: ssky-0.2.8-py3-none-any.whl
- Upload date:
- Size: 40.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.12.12 Linux/6.11.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1a04796d345e1a279598258559a2cfa8eb403b4d23df9fb4ae4aedc53c47f1f8
|
|
| MD5 |
dc60f23911bd8efd2e517e262351a883
|
|
| BLAKE2b-256 |
0076e22a67b50070cfc388c2919e822f342e8a18737d4ef85593f86d749f9e40
|