Skip to content
samikshaanirudh edited this page Jul 26, 2024 · 62 revisions

Getting Started

We provide the following ways to build SVF from its source code:

(1) Build SVF using cmake (tested on both Ubuntu and MacOS)
sudo apt install cmake gcc g++ libtinfo5 libz-dev libzstd-dev zip wget libncurses5-dev ##(If running on Ubuntu 20.04)

git clone https://github.com/SVF-tools/SVF.git
cd SVF
source ./build.sh
(2) Build SVF using npm (tested on both Ubuntu and MacOS)
npm i svf-lib
(3) Build SVF using Docker (Ubuntu OS)
docker pull svftools/svf:latest
docker run -it svftools/svf:latest /bin/bash 
or
git clone https://github.com/SVF-tools/SVF.git
cd SVF
docker build -t "svf" .
(4) Set up SVF in VSCode Following here or here
(5) CLion Follow the above link to another documentation page.
(6) Build SVF via Windows Linux Subsystem (WSL)

Follow Microsoft's guide on how to install WSL or Installing C++ and WSL in VSCode if you are using VSCode.
Once WSL is installed, simply run the wsl command to enter wsl and use either (1) or (2) to build SVF.
This has been tested with Windows v10.0.18363 + Ubuntu 18.04 LTS


The above installation guide has been tested on OSX 10.10.3, Ubuntu 14.04, and Windows Linux Subsystem (WSL v10.0) but it should work on most Linux-based systems.