Skip to main content

Open-source CLI for composing and publishing X posts

Project description

xcli

xcli is a command line tool for interacting with the X API.

It is designed for local-first usage, safe publishing defaults, and open-source packaging.

Install

Install from PyPI:

pip install xcli-v2

Quickstart

  1. Set OAuth app credentials:
export TWITTER_CLIENT_ID="..."
export TWITTER_CLIENT_SECRET="..."

Set your app callback/redirect URL to http://localhost:3000/callback. If needed, override in the CLI with XCLI_REDIRECT_URI.

  1. Run login flow (prints an auth URL you can open manually):
xcli auth login

Optional: attempt auto-open in your default browser:

xcli auth login --open-browser
  1. Draft content:
xcli compose "shipping small daily"
  1. Post from terminal text (default):
xcli post "shipping small daily"
  1. Preview without posting:
xcli post "shipping small daily" --dry-run
  1. Post from file:
xcli post --file draft.txt
  1. Attach media (repeat --media up to 4 files):
xcli post "launch day" --media image1.png --media image2.jpg

Currently supported media types are image uploads accepted by the X media upload endpoint (jpeg, png, webp, bmp, tiff). Media upload requires OAuth scope media.write; if you logged in before this was added, run xcli auth login again to refresh token scopes.

Commands

  • xcli auth login
  • xcli auth whoami
  • xcli auth status
  • xcli auth logout
  • xcli compose
  • xcli post
  • xcli reply --to <tweet_id>
  • xcli quote --to <tweet_id>
  • xcli posts mine
  • xcli posts get --id <tweet_id>
  • xcli timeline --user <handle>

Safety model

  • Posting commands send by default (with confirmation prompt).
  • Use --dry-run to preview payload without posting.
  • Non-interactive workflows can use --yes.
  • Machine output is available with --json.

Auth storage

Default token path uses platform config directories:

  • macOS: ~/Library/Application Support/xcli/auth.json
  • Linux: ~/.config/xcli/auth.json
  • Windows: %APPDATA%\\xcli\\auth.json

Legacy compatibility fallback is supported for ~/.twitter/auth.json.

Development

pip install -e .[dev]
pytest
ruff check
mypy src

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

xcli_v2-0.1.1.tar.gz (57.3 kB view details)

Uploaded Source

Built Distribution

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

xcli_v2-0.1.1-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file xcli_v2-0.1.1.tar.gz.

File metadata

  • Download URL: xcli_v2-0.1.1.tar.gz
  • Upload date:
  • Size: 57.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for xcli_v2-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ef7bef5ac62f730f071e007c67bd71f444f8fb5e368330b73b98f898f2328e9b
MD5 3234dffc8ad9d5331d5b5bd6b2a7768c
BLAKE2b-256 78fdbc136c30ca9ba8d404ad4ccfc785cae87b2bf796fb4c715562cfb391a53a

See more details on using hashes here.

File details

Details for the file xcli_v2-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: xcli_v2-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for xcli_v2-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eb3997a42ed05d47be7395f3cbe6ed36d70aa8d0b9ad1df50c6836d7f0ae3d5e
MD5 7300be9a8c9b6371989662027503dbdb
BLAKE2b-256 46ba7557bbdc5fa8eed7e529a7921d069990c29e5a28042f7d4fdba0438da166

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