Installation

twitter-cli can be installed in multiple ways depending on your workflow preferences. All methods provide the same functionality.

Prerequisites

Python Version: twitter-cli requires Python 3.8 or higher.

Verify your Python version:

python3 --version

Installation Methods

uv (Recommended)
pipx
From Source
pip (Not Recommended)

Install with uv tool

uv is a fast Python package installer and resolver. This is the recommended installation method as it provides isolated environments and fast installation.

Install uv

If you don’t have uv installed:

curl -LsSf https://astral.sh/uv/install.sh | sh

Or on Windows:

powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

Install twitter-cli

uv tool install twitter-cli

This installs twitter-cli in an isolated environment and makes the twitter command available globally.

Verify Installation

twitter --version

You should see output like:

twitter, version 0.4.6

uv automatically manages dependencies and creates isolated environments, preventing conflicts with other Python packages.

Install with pipx

pipx is a tool for installing Python applications in isolated environments.

Install pipx

If you don’t have pipx installed:

# On macOS
brew install pipx
pipx ensurepath

# On Linux
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# On Windows
python -m pip install --user pipx
python -m pipx ensurepath

Install twitter-cli

pipx install twitter-cli

Verify Installation

twitter --version

Install from Source

For development or to use the latest unreleased features:

Clone the Repository

git clone [email protected]:jackwener/twitter-cli.git
cd twitter-cli

Install with uv

uv sync

This creates a virtual environment and installs all dependencies.

Run twitter-cli

# Activate the virtual environment
source .venv/bin/activate  # On Linux/macOS
.venv\Scripts\activate     # On Windows

# Run the CLI
twitter --version

Or use uv run without activating:

uv run twitter --version

When installing from source, you can also install development dependencies:

uv sync --extra dev

This includes tools like pytest and ruff for testing and linting.

Install with pip

Installing with pip is not recommended as it can cause dependency conflicts with other Python packages. Use uv or pipx instead.

If you must use pip:

pip install twitter-cli

Consider using a virtual environment to avoid conflicts:

python3 -m venv venv
source venv/bin/activate  # On Linux/macOS
venv\Scripts\activate     # On Windows
pip install twitter-cli

Dependencies

twitter-cli automatically installs the following dependencies:

browser-cookie3 (≥0.19): Extracts cookies from browsers
click (≥8.0): Command-line interface framework
rich (≥13.0): Terminal formatting and output
PyYAML (≥6.0): Configuration file parsing
curl_cffi (≥0.7): TLS fingerprint impersonation
xclienttransaction (≥1.0.1): Twitter transaction ID generation
beautifulsoup4 (≥4.12): HTML parsing

All dependencies are managed automatically. You don’t need to install them manually.

Upgrading

To upgrade to the latest version:

uv tool upgrade twitter-cli

Uninstalling

To remove twitter-cli:

uv tool uninstall twitter-cli

Troubleshooting Installation

Command not found after installation

After installing with uv or pipx, the twitter command might not be in your PATH.Solution: Restart your terminal or run:

# For uv
export PATH="$HOME/.local/bin:$PATH"

# For pipx
pipx ensurepath

Add the export line to your shell config (~/.bashrc, ~/.zshrc, etc.) to make it permanent.

Permission denied errors

If you see permission errors during installation:Solution: Never use sudo with pip. Instead, use uv or pipx which install to user directories, or use a virtual environment.

Python version mismatch

twitter-cli requires Python 3.8 or higher.Solution: Check your Python version:

python3 --version

If it’s too old, install a newer version:

# On macOS
brew install [email protected]

# On Ubuntu/Debian
sudo apt install python3.11

SSL certificate errors

On some systems, you might encounter SSL certificate verification errors.Solution: Update your system’s CA certificates:

# On macOS
/Applications/Python\ 3.x/Install\ Certificates.command

# On Ubuntu/Debian
sudo apt install ca-certificates
sudo update-ca-certificates

Next Steps

Quick Start

Now that you have twitter-cli installed, let’s get you from zero to your first successful command.

Get Started

Read Commands

Write Commands

Configuration

Guides

Reference

Prerequisites

Installation Methods

Install with uv tool

Install with pipx

Install from Source

Install with pip

Dependencies

Upgrading

Uninstalling

Troubleshooting Installation

Next Steps

Quick Start

Build docs developers (and LLMs) love

Get Started

Read Commands

Write Commands

Configuration

Guides

Reference

​Prerequisites

​Installation Methods

​Install with uv tool

​Install with pipx

​Install from Source

​Install with pip

​Dependencies

​Upgrading

​Uninstalling

​Troubleshooting Installation

​Next Steps

Quick Start

Build docs developers (and LLMs) love

Prerequisites

Installation Methods

Install with uv tool

Install with pipx

Install from Source

Install with pip

Dependencies

Upgrading

Uninstalling

Troubleshooting Installation

Next Steps