Install Vulnlog
Install the Vulnlog CLI on your computer, or run Vulnlog in Docker, in GitHub Actions, or in a Gradle build. Choose the method that fits where you run Vulnlog.
Install the CLI
Choose the method for your computer:
-
Install script
-
Homebrew
-
Download
On Linux and macOS, the install script downloads the latest release and installs it for your user.
It needs curl and unzip.
-
Run the script:
$ curl -fsSL vulnlog.dev/install | shThe script detects your operating system and processor and installs the native binary to
~/.local/bin. If~/.local/bindoesn’t exist, it uses~/bin. -
If the script reports that the directory isn’t in your
PATH, add theexportline it prints to your shell configuration, and open a new terminal. -
Check the installation:
$ vulnlog --version vulnlog version 0.19.0
Native binaries are available for Linux on x86-64, macOS on Apple silicon, and Windows on x86-64.
On other platforms, the script installs the JVM distribution instead, which needs Java 21 or later.
To install the JVM distribution on a platform that has a native binary, pass --jvm:
$ curl -fsSL vulnlog.dev/install | sh -s -- --jvm
Each release on the Vulnlog releases page also has the script for that version, install-vulnlog.sh.
To uninstall Vulnlog, run the uninstall script:
$ curl -fsSL vulnlog.dev/uninstall | sh
On macOS, install Vulnlog from the Vulnlog tap:
$ brew install vulnlog/vulnlog/vulnlog
To upgrade to the latest release:
$ brew update && brew upgrade vulnlog
Use this method on Windows, or when you can’t run the install script.
-
On the Vulnlog releases page, download the archive for your platform:
vulnlog-linux-amd64.zip,vulnlog-macos-aarch64.zip, orvulnlog-windows-amd64.zip. -
Extract the archive.
-
Move the
vulnlogbinary (vulnlog.exeon Windows) to a directory in yourPATH. -
Run
vulnlog --versionto check the installation.
For other platforms, download the JVM distribution, vulnlog-0.19.0.zip, from the same page.
It needs Java 21 or later.
Extract it and add its bin directory to your PATH.
Run in Docker
The Vulnlog image is ghcr.io/vulnlog/vulnlog.
Each release has an image tagged with its version number.
-
Pull the image and check it:
$ docker pull ghcr.io/vulnlog/vulnlog:0.19.0 $ docker run --rm ghcr.io/vulnlog/vulnlog:0.19.0 --version vulnlog version 0.19.0 -
Mount your project directory at
/work, the working directory in the container, and run any Vulnlog command:$ docker run --rm -v "$PWD:/work" ghcr.io/vulnlog/vulnlog:0.19.0 validate vulnlog.yaml Validated: vulnlog.yaml
The container runs as user ID 1000.
If your user ID is different, Vulnlog can’t write files to the mounted directory and reports permission denied.
Run the container as your own user to fix this:
$ docker run --rm --user "$(id -u):$(id -g)" -v "$PWD:/work" ghcr.io/vulnlog/vulnlog:0.19.0 report impact vulnlog.yaml
To read a single file without a mount, pass it on standard input with -i and use - as the file name:
$ docker run --rm -i ghcr.io/vulnlog/vulnlog:0.19.0 validate - < vulnlog.yaml
Validated: <stdin>
For the commands that read from standard input or write to standard output, see Standard input and output.
Set up in GitHub Actions
Add the Setup Vulnlog CLI action to your job.
It installs the CLI and puts it in the PATH, so later steps can run vulnlog:
- name: Set up Vulnlog CLI
uses: vulnlog/setup-vulnlog@v1
with:
version: 0.19.0
For the inputs and outputs of the action, see GitHub Action. For a complete workflow, see Run in CI pipelines.
Add the Gradle plugin
In a Gradle build, apply the Vulnlog plugin in build.gradle.kts.
Gradle downloads it from the Gradle Plugin Portal:
plugins {
id("dev.vulnlog.plugin") version "0.19.0"
}
You don’t need to install the CLI for the plugin. For its tasks and settings, see Gradle plugin.
Build from source
You need Git and a JDK to run Gradle. Gradle downloads the JDK version that the build needs.
-
Clone the repository and build the distribution:
$ git clone https://github.com/vulnlog/vulnlog.git $ cd vulnlog $ ./gradlew installDist -
Run the CLI from the build directory:
$ modules/cli-app/build/install/vulnlog/bin/vulnlog --version
Next steps
-
Record your first finding in Triage your first finding.
-
Set up your editor to check Vulnlog files as you type with Set up your editor.