Installation

You can installed pre-built binaries of VulnAPI on Linux, Windows, and MacOS.

Below are the instructions to install VulnAPI on Linux, Windows, MacOS, and Docker. You can choose the installation method that best suits your needs and environment.

Linux

Snap

You can install VulnAPI on Linux using Snap.

sudo snap install vulnapi

Verify:

vulnapi --version

APT

Download the latest VulnAPI release and install it using dpkg.

sudo dpkg -i vulnapi.deb

Verify:

vulnapi --version

RPM

Download the latest VulnAPI release and install it using rpm -i.

sudo rpm -i vulnapi.rpm

Verify:

vulnapi --version

Other

You can install VulnAPI on Linux by downloading the latest VulnAPI release and extracting the contents of the ZIP file. After extracting the contents, run the vulnapi binary from the command line.

Verify:

vulnapi --version

Windows

Chocolatey

You can install VulnAPI on Windows using Chocolatey.

choco install vulnapi

You can also install VulnAPI on Windows by downloading the latest VulnAPI release and extracting the contents of the ZIP file. After extracting the contents, you can run the vulnapi.exe binary from the command line.

Verify:

vulnapi --version

MacOS (Homebrew)

You can install VulnAPI on MacOS using Homebrew. To do so, run the following command:

brew tap cerberauth/vulnapi https://github.com/cerberauth/vulnapi
brew install $(brew --repository cerberauth/vulnapi)/vulnapi.rb

Verify:

vulnapi --version

Docker

You can also use VulnAPI as a Docker container with VulnaAPI Docker Image. To do so, run the following command:

docker run --rm cerberauth/vulnapi scan curl [API_URL] [CURL_OPTIONS]

GitHub Action

VulnAPI can be integrated into your CI/CD pipeline using GitHub Actions. Integrating VulnAPI with GitHub Actions enables you to scan your APIs for vulnerabilities and security risks as part of your CI/CD pipeline. This allows you to automate security testing and vulnerability scanning of your APIs as part of your development workflow, ensuring that your APIs are secure and free from vulnerabilities before they are deployed to production.

Upgrading

Keep VulnAPI up to date to get the latest vulnerability checks and bug fixes.

Platform	Command
Snap	sudo snap refresh vulnapi
Chocolatey	choco upgrade vulnapi
Homebrew	brew upgrade vulnapi
Docker	docker pull cerberauth/vulnapi

For APT/RPM installations, download the latest release package and reinstall using the same commands as above.