Skip to content

Installation

Hyper-Extract requires Python 3.11+.


Install as CLI Tool

If you want to use the he command from anywhere:

Install uv first (if you haven't):

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

Then install Hyper-Extract:

uv tool install hyperextract
pipx install hyperextract

Don't have pipx? Install it with pip install pipx.


Install as Python Library

If you want to use Hyper-Extract in your Python code:

uv pip install hyperextract
pip install hyperextract

Verify Installation

he --version

You should see something like:

Hyper-Extract CLI version 0.4.0
import hyperextract
print(hyperextract.__version__)

Development Installation

If you want to contribute or modify the source code:

git clone https://github.com/yifanfeng97/hyper-extract.git
cd hyper-extract

# Install with uv (recommended)
uv sync --extra dev

# Or with pip
pip install -e ".[dev]"

What's Next?