Skip to main content

A Python CLI wrapper around the atproto package

Project description

atpcli

A Python CLI wrapper around the atproto package for interacting with Bluesky.

Documentation

Full documentation is available at docs/:

Or serve the docs locally:

make docs-serve

Quick Start

Installation

Install globally using uv:

uv tool install atpcli

This installs atpcli as a global tool, making it available from anywhere in your terminal.

Or for development:

git clone https://github.com/phalt/atpcli.git
cd atpcli
make install

Usage

Login

⚠️ Security Note: Use app passwords, not your main password! See the Quick Start Guide for instructions on creating an app password.

Login to an AT Protocol PDS (defaults to Bluesky):

atpcli login

Or login to a custom PDS:

atpcli login https://my-pds.com

You'll be prompted for your handle and password. The session will be saved to ~/.config/atpcli/config.json.

View Timeline

View your timeline:

atpcli bsky timeline

Options:

  • --limit N - Show N posts (default: 10)
  • --p N - Show page N (default: 1)

Example:

atpcli bsky timeline --limit 20
atpcli bsky timeline --p 2

Post Messages

Create a post on Bluesky using the interactive editor:

atpcli bsky post

Or post directly with a message:

atpcli bsky post --message 'Hello, Bluesky!'

Note: When using special characters like !, use single quotes to avoid shell expansion issues, or use the interactive editor mode. See the Post Command documentation for more details.

Custom Feeds

List your saved Bluesky feeds:

atpcli bsky feeds

View posts from a specific feed:

atpcli bsky feed at://did:plc:xxx/app.bsky.feed.generator/discover

Options:

  • --limit N - Show N posts (default: 10)
  • --p N - Show page N (default: 1)
  • --format uri - Output only URIs (for feeds command)

Example:

# List feeds in URI format for scripting
atpcli bsky feeds --format uri

# View a feed with more posts
atpcli bsky feed at://did:plc:xxx/app.bsky.feed.generator/tech --limit 20

# Navigate to page 2
atpcli bsky feed at://did:plc:xxx/app.bsky.feed.generator/tech --p 2

See the Feeds Commands documentation for more details.

Development

Setup

make install

Run tests

make test

Build documentation

make docs-build

Serve documentation locally

make docs-serve

Format code

make format

Clean build artifacts

make clean

Requirements

  • Python 3.10+
  • uv package manager

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atpcli-0.6.0.tar.gz (125.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

atpcli-0.6.0-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file atpcli-0.6.0.tar.gz.

File metadata

  • Download URL: atpcli-0.6.0.tar.gz
  • Upload date:
  • Size: 125.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.6

File hashes

Hashes for atpcli-0.6.0.tar.gz
Algorithm Hash digest
SHA256 2aa4d73374f620e1fc4266baaaa463777a3d4dc39e5663f1945bea54df69567f
MD5 bd08b19d9424cb8f96e893fab75b77ba
BLAKE2b-256 7c65f5dcc7fe027e6eff569c56d6243a7751529c4d989be34468c2389c420659

See more details on using hashes here.

File details

Details for the file atpcli-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: atpcli-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 17.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.6

File hashes

Hashes for atpcli-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bce8b0f0e48f3f6e1506fccb8178ac03790536aca62f03f2af64059a125105da
MD5 b8658ed2ba56da2bbe1925d959fc103c
BLAKE2b-256 686085f502a2f6c3f3af6df1a4eb48ed8fdb3df99e4f7df526279da61b8d0f2a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page