Skip to content

Installation

Cyvest is published on PyPI. Installing the package gives you both the cyvest module and the cyvest CLI; nothing else is required to build, score, and serialize an investigation.

Requirements Checklist

Component Minimum
Python >= 3.10
Package manager uv or pip
Node.js >= 22, only for the @cyvest/* JavaScript packages 
uv add cyvest

To get the CLI without adding Cyvest to a project:

uv tool install cyvest

Or run it once without installing anything:

uvx --from cyvest cyvest --help

Option 2 · pip

python -m venv .venv
source .venv/bin/activate       # Windows: .venv\Scripts\activate

pip install cyvest

Option 3 · From source

Use this only to work on Cyvest — see Contributing for the full loop.

git clone https://github.com/PakitoSec/cyvest.git
cd cyvest

# Runtime + dev + docs dependency groups, resolved from uv.lock
uv sync --all-groups

uv sync installs the project in editable mode, so uv run cyvest reflects your working tree immediately. There is no separate uv pip install -e . step.

JavaScript packages

pnpm add @cyvest/cyvest-js          # typed reader for the JSON documents
pnpm add @cyvest/cyvest-vis         # React graph components

Their version tracks the Python one: @cyvest/cyvest-js@7.2.0 reads the documents written by cyvest==7.2.0 (investigation schema 7.1.0), as well as 7.0 documents. See JS packages.

Post-Install Validation

# Confirm the module resolves
python -c "import cyvest; print(cyvest.__version__)"

# Confirm the CLI entrypoint
cyvest --version

Both must report the same version.

Next Steps