Skip to content

Installation

Requirements

Before installing httptap, ensure you have:

  • Python 3.10-3.15 (CPython recommended)
  • pip or uv package manager
  • macOS, Linux, or Windows operating system

No system dependencies beyond standard networking are required.

Running with uvx

The fastest way to run httptap without a permanent install. uvx (shipped with uv) fetches httptap and runs it in an ephemeral, isolated environment:

uvx --from "httptap[completion]" httptap https://example.com

Recommended for a quick try

uvx needs no prior install step and leaves nothing behind — ideal for one-off checks or trying httptap out. For repeated use, install it with one of the methods below.

Installing via Homebrew

brew install httptap

brew install httptap

Convenient for macOS/Linux users

Homebrew installation is the simplest method and includes automatic shell completion setup.

Installing from PyPI

uv pip install httptap

Or install as a global tool:

uv tool install httptap

pip install httptap

For isolated CLI tool installation:

pipx install httptap

Running via Container

Signed multi-arch (linux/amd64, linux/arm64) images are published to GitHub Container Registry on every release:

docker run --rm ghcr.io/ozeranskii/httptap:latest https://example.com

Verify the image signature with cosign (keyless Sigstore):

cosign verify ghcr.io/ozeranskii/httptap:latest \
  --certificate-identity-regexp 'https://github\.com/ozeranskii/httptap/\.github/workflows/release\.yml@.*' \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com

Pinned major/minor tags (e.g. :0, :0.6, :0.6.0) are also published.

Installing from Source

Clone the repository

git clone https://github.com/ozeranskii/httptap.git
cd httptap

Install with uv

uv sync

Install with pip

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -e .

Verifying Installation

After installation, verify that httptap is correctly installed:

httptap --version

You should see output similar to:

httptap X.Y.Z

Upgrading

To upgrade httptap to the latest version:

brew upgrade httptap

uv pip install --upgrade httptap

pip install --upgrade httptap

Uninstalling

To remove httptap from your system:

brew uninstall httptap

uv pip uninstall httptap

pip uninstall httptap

pipx uninstall httptap

Shell Completions

httptap supports shell completions for bash and zsh.

Homebrew Installation

If you installed httptap via Homebrew, completions are automatically configured. Simply restart your shell:

# Restart your shell
exec $SHELL

Homebrew automatically places completion scripts in:

  • Bash: $(brew --prefix)/etc/bash_completion.d/
  • Zsh: $(brew --prefix)/share/zsh/site-functions/

No additional setup required

Homebrew handles all completion setup automatically. Just restart your shell and start using Tab completion!

Python Package Installation

If you installed httptap via pip, uv, or pipx, you need to install the optional completion extras:

uv pip install "httptap[completion]"

pip install "httptap[completion]"

pipx install "httptap[completion]"

Activation

  1. Activate your virtual environment (if using venv):

    source .venv/bin/activate

  2. Enable completion for bash/zsh. Either register it globally once:

    activate-global-python-argcomplete

    Or, to enable it only for httptap, add this to your shell startup file (e.g. ~/.bashrc or ~/.zshrc):

    eval "$(register-python-argcomplete httptap)"

  3. Restart your shell.

Usage

Once installed and activated, you can use Tab to autocomplete commands and options:

# Complete command options
httptap --<TAB>

# Complete after typing partial option
httptap --fol<TAB>
# Completes to: httptap --follow

# Complete multiple options
httptap --follow --time<TAB>
# Completes to: httptap --follow --timeout

Note

The global activation script provides argument completions for bash and zsh only. Other shells are not covered by the script and must be configured separately.

What's Next?