Install LiveAPISec with pip

Recommended: install with pipx

pipx installs the CLI in its own virtualenv and puts liveapisec on your PATH — no sudo, and no conflicts with your project dependencies. This is the setup we recommend for local development and CI images.

pipx install liveapisec
liveapisec --help

If pipx is not installed yet: python3 -m pip install --user pipx && python3 -m pipx ensurepath, then reopen the terminal.

Install with pip inside a virtualenv

If you already use a virtualenv (or a container where the app runs), a plain pip install is fine. Never install into the system Python on a PEP 668 distribution.

python3 -m venv .venv
source .venv/bin/activate
pip install liveapisec
liveapisec --help

One-line installer (Linux / macOS)

The installer uses pipx when available, otherwise it creates an isolated virtualenv and symlinks the command into ~/.local/bin. It needs no sudo and works on PEP 668 systems.

curl -fsSL https://raw.githubusercontent.com/LiveApiSec/liveapisec/main/install.sh | bash

Install from GitHub (build from source)

pip install "liveapisec @ git+https://github.com/LiveApiSec/liveapisec.git"

Use this only when you need unreleased changes. For production pipelines, pin a released version from PyPI for reproducible builds.

Docker and CI images

Install once in the image, then the liveapisec command is available in every step. The same works in GitHub Actions, GitLab CI, Jenkins and any container-based runner.

FROM python:3.12-slim
RUN pip install --no-cache-dir pipx \
 && pipx install liveapisec \
 && pipx ensurepath
ENV PATH="/root/.local/bin:$PATH"
ENTRYPOINT ["liveapisec"]

Common install errors

`error: externally-managed-environment` — you are running pip against the system Python (Ubuntu 24.04+, Debian 12+, Homebrew Python). Use pipx or a virtualenv. `liveapisec: command not found` — the install directory is not on PATH; run pipx ensurepath or add ~/.local/bin.

Verify the version and the resolved path with liveapisec --version and which liveapisec.

FAQ

Should I use pip or pipx to install LiveAPISec?

Use pipx for a global CLI install: it isolates dependencies and works on PEP 668 systems. Use pip only inside an activated virtualenv or a container image.

Does the LiveAPISec CLI work on Windows?

The CLI is Python-based and runs on Windows. For the most predictable experience (and the one-line installer), use WSL2 or a Linux container; on native Windows, install with pipx inside Python 3.10+.

How do I upgrade the CLI?

Run `pipx upgrade liveapisec`, or `pip install --upgrade liveapisec` inside the virtualenv. CI pipelines should pin a version and upgrade deliberately.