Installation

Python 3.12 is required. uv installs an isolated global command and can download the selected Python version. Python 3.13 and newer are outside the supported release scope.

First, install uv

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

winget install --id=astral-sh.uv -e

Open a new terminal afterward. Follow the installer’s PATH instructions, then run uv --version.

• Official uv installation instructions

Install the CLI

uv tool install --python 3.12 "ragvidence==0.2.1"
ragvi --version
ragvi health
ragvi verify

verify runs deterministic bundled checks without downloading a model. A WARN for an absent optional semantic runtime does not block BM25.

Upgrade an existing installation

uv tool install --upgrade --python 3.12 "ragvidence==0.2.1"
ragvi --version
ragvi verify

Optional extras

uv tool install --reinstall --python 3.12 "ragvidence[pdf,semantic]==0.2.1"

pdf adds text-bearing PDF extraction, without OCR. semantic adds local FastEmbed embeddings and cross-encoder reranking. Include every extra you need when reinstalling. First model use downloads model files; inference is then local. Choose --cache-dir for model/vector storage.

Tested platforms

Automated installed-package release checks cover Linux x64, Windows x64, macOS ARM64 and macOS Intel with Python 3.12. Real-model checks use identified Linux configurations; this is not a claim that every model/hardware combination works on every OS. Human Windows usability review remains deferred.

Uninstall

uv tool uninstall ragvidence

Experiment files and reports remain where you saved them. If ragvi is missing from PATH, run uv tool update-shell and restart the terminal.

• Source builds and full installation guidance