Installation¶

Privyx is a Python package with a command-line program, privyx. It needs Python 3.12 or newer. A Docker image is published for every release.

Install¶

pipuvNo installDocker

pip install privyx

On an older Python, pip stops with No matching distribution found for privyx. Check with python --version.

uv tool install privyx       # the `privyx` command, in its own environment

Or add it to a project: uv add privyx.

uvx privyx --version

uvx downloads Privyx into a cache and runs it. Every privyx ... command in this documentation works as uvx privyx ....

docker run --rm ohp1x/privyx --version

The image holds every extra below. See Docker.

This installs the proxy, the privacy engine, and the CLI.

Extras¶

Extras switch on optional components. Nothing below is needed for the default setup.

Extra	Installs	Needed for
`sqlite`	aiosqlite	`vault.type: sqlite`
`redis`	redis	`vault.type: redis`
`presidio`	Presidio, spaCy	the `presidio` detector
`providers`	OpenAI and Anthropic SDKs	the `llm` detector
`faker`	Faker	the `faker` operator
`crypto`	cryptography	the `encrypt` operator

Combine them as needed:

pipuvNo install

pip install 'privyx[sqlite,faker]'

uv tool install 'privyx[sqlite,faker]'

uvx --from 'privyx[sqlite,faker]' privyx --version

A setting that needs a missing extra fails at startup, with the install command in the message:

$ privyx proxy -c sqlite.yaml
Error: aiosqlite is required. Install with `pip install privyx[sqlite]`.

Check the installation¶

$ privyx --version
privyx, version 0.1.14
$ privyx doctor
Privyx Doctor
=============
  ✓ plugins: no plugin paths configured
  ✓ detector: regex: 1 span(s) ['EMAIL']
  ✓ vault: memory: round-trip ok
  ✓ provider: generic → http://localhost:20128
  ✓ proxy: request transformed, 1 mapping(s) vaulted
  ✓ streaming: pseudonym restored across a split chunk
  ✓ configuration: valid: detector=regex policy=default operator=pseudonym vault=memory anchor=off

privyx doctor builds every configured component and pushes a sample request through it, without calling a provider. Run it with -c your.yaml after changing a config file.

Upgrade¶

pipuvNo installDocker

pip install --upgrade privyx

uv tool upgrade privyx

uvx privyx@latest --version

docker pull ohp1x/privyx

The changelog lists what each release changed. Privyx is in its 0.1.x series: a release can change a default, and the changelog says so under "Changed".

Next steps¶

Quickstart: mask a first request.
How it works: what happens to a request, and the terms used in these pages.