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:

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

Note: When using special characters like !, use single quotes to avoid shell expansion issues. 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.5.0.tar.gz (123.6 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.5.0-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for atpcli-0.5.0.tar.gz
Algorithm Hash digest
SHA256 52f33e65a671d274b997771cb1feaf3a9fde5f873979d88e914d8e1d8723e96e
MD5 fdb64025667a37d82325aa690c00237a
BLAKE2b-256 b50cd46eb9909b770f2fa32f1fcaf963ff01572042c92a5075938e2ae4a3b60e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for atpcli-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ff17eade6d142d4e139b2de0bd47b2faeff7023badf5d50eb73ec90c64a5182
MD5 f54c10325e520360a48c13bd68bba363
BLAKE2b-256 21f3b9aaacf3b8f2ee2c7806fd109569bb0af666c897b9c7a7d8d6c0794543e6

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