Setup Guide

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)

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-tools

(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) VSCode

Follow the above link to another documentation page.

(5) CLion

Follow the above link to another documentation page.

(6) Build SVF using NPM via Windows Linux Subsystem (WSL)

Follow Microsoft's guide on how to install WSL.
Once WSL is installed, run the wsl command to enter wsl and SVF can be built using either (1) or (2).
Once installed when in your working directory simply run the wsl command to enter wsl, then you can access the svf-tools commands.
This has been tested with Windows v10.0.18363 + Ubuntu 20.04 LTS

---

The above installation guide has been tested on OSX 10.10.3 and Ubuntu 14.04, but it should work on most Linux-based systems.