VIP - Verified Installation of Posit
An open-source, extensible test suite that validates Posit Team deployments are installed correctly and functioning properly.
VIP uses BDD-style tests (pytest-bdd + Playwright) to verify Connect, Workbench, and Package Manager deployments. Results can be viewed from the command-line output or compiled into an HTML report.
Documentation: https://posit-dev.github.io/vip/
Quick start
uv tool install posit-vip
vip install
vip verify --connect-url https://connect.example.com --interactive-auth
Run VIP from your own workstation or a CI runner, not the Connect, Workbench,
or Package Manager servers themselves: VIP checks the deployment the way a
real client would (over the same URL, proxy, and TLS termination your users
go through), and --interactive-auth opens a visible browser window that
those servers typically don't have a display for. On a headless server, use
--headless-auth or --api-auth instead (see below).
Reproducible install
uv tool install posit-vip resolves the newest versions each release allows. To
install the exact set a release was tested against, pass that release's
constraints file (attached to every GitHub release as constraints-<version>.txt):
uv tool install posit-vip \
-c https://github.com/posit-dev/vip/releases/download/vX.Y.Z/constraints-X.Y.Z.txt
Replace X.Y.Z with the release you are installing (see the
releases page).
For a fully pinned, batteries-included environment, use the container image,
which installs from the committed uv.lock:
docker run --rm -v "$PWD/vip.toml:/app/vip.toml" ghcr.io/posit-dev/vip:latest
On a headless server (no display), use --headless-auth instead:
vip verify --config vip.toml --headless-auth
Run a specific test by name:
vip verify --connect-url https://connect.example.com --filter test_login
With a configuration file:
cp vip.toml.example vip.toml # edit with your deployment details
vip verify --config vip.toml
Fast confidence check — skip the detailed/long-running checks:
vip verify --config vip.toml --basic
Uninstalling
To reverse what vip install (or just setup) did:
vip uninstall # dry run; prints the full plan including any sudo command
vip uninstall --yes # remove Playwright cache + manifest; prints the sudo command
# for any system packages so you can remove them yourself
uv tool uninstall posit-vip # remove vip itself once you're done
vip uninstall only removes packages and files that vip install recorded
in .vip-install.json; anything that was already on your machine before
running vip install is left alone.
If a Connect URL is configured (in vip.toml or via --connect-url),
vip uninstall chains vip cleanup first to remove _vip_test-tagged
content from Connect.
CLI commands
| Command | Description |
|---|---|
vip verify |
Run verification tests against a Posit Team deployment |
vip status |
Quick health check for each configured product |
vip cleanup |
Delete VIP _vip_test content from Connect |
vip report |
Render the HTML report from test results (requires Quarto CLI) |
vip auth |
Authentication tools (e.g. mint Connect API keys) |
vip version |
Print the vip version and the minimum supported Posit Team version |
vip --version |
Print the installed vip version |
Run vip --help or vip <command> --help for full usage details.
CI / pipeline integration
VIP emits machine-readable output for security-ops and CI/CD pipelines.
vip verify always writes report/results.json (and report/failures.json on
failures). Add JUnit XML and/or SARIF with --format:
vip verify --format json,junit,sarif
# report/results.json (always)
# report/junit.xml (--format junit) -> CI test dashboards
# report/results.sarif (--format sarif) -> GitHub code scanning / secops
Skip messages in the JUnit and SARIF output carry the actual skip reason
instead of a generic "skipped" label. A check VIP was asked to run but could
not -- a configured product whose authentication never completed, say -- is
reported as unproven rather than as an ordinary skip: it carries an
UNPROVEN: prefix in JUnit, SARIF level warning, and exits 6 so a
pipeline can tell "the deployment is broken" (exit 1) from "the deployment
could not be checked" (exit 6). Pass --allow-unproven to exit 0 anyway. results.json also records provenance
for the run (VIP version, duration, Python version, platform, and whether the
slow checks were excluded) so an archived report can be traced back to what
produced it.
The --ci preset bundles all three formats with concise tracebacks (--tb=short)
and overrides --format if both are given. Run it without --interactive-auth/
--headless-auth -- combining them is an error, since --ci is meant for
non-interactive pipelines:
vip verify --ci
Container
An official image is published to ghcr.io/posit-dev/vip. The entrypoint is the
vip CLI; the default subcommand is verify. Because docker run args replace
the default command (they do not append to it), name the verify subcommand
explicitly when passing verify flags:
# bare invocation runs `vip verify`:
docker run --rm -v "$PWD/vip.toml:/app/vip.toml" ghcr.io/posit-dev/vip
# CI preset (name the subcommand so args don't replace it):
docker run --rm -v "$PWD/vip.toml:/app/vip.toml" ghcr.io/posit-dev/vip verify --ci
# other subcommands are reachable too:
docker run --rm -v "$PWD/vip.toml:/app/vip.toml" ghcr.io/posit-dev/vip status --json
Development
See docs/development.md for dev setup, linting, and formatting.
For the test architecture and four-layer design, see docs/test-architecture.md.
License
MIT — see LICENSE.
2 maintainers
Release files for posit-vip 2026.9.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| posit_vip-2026.9.3.tar.gz | 2.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| posit_vip-2026.9.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.6 MB
Release files / posit_vip-2026.9.3.tar.gz
| Download URL | posit_vip-2026.9.3.tar.gz |
|---|---|
| Size | 2.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5a448544c374d1428f1b8b06feff72548c4fb4b6684065d4ec885c215a2442d0
|
|
BLAKE2b-256 checksum How to use checksums |
22989b3ac66aedf35386b2779cc3e507fc923cd510a5b27faf98e76619046d5e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.
Transparency logRelease files / posit_vip-2026.9.3-py3-none-any.whl
| Download URL | posit_vip-2026.9.3-py3-none-any.whl |
|---|---|
| Size | 1.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d59107643471251eace238859807ab169c19d9b6f61522e324b958e5cbf27075
|
|
BLAKE2b-256 checksum How to use checksums |
011d3494a227e860e78d0df2fec84cf80102d5d77fedb17e464ca0d301eb1bbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.
Transparency log
