Create a Vulnlog file

Create the Vulnlog file of your project, add the releases you support, and commit it next to your code.

Before you start

  • The Vulnlog CLI. See Install Vulnlog.

  • The names of your organisation, your project, and the team that maintains the file.

Create the file

  1. In the root of your repository, run vulnlog init:

    $ vulnlog init --organization "Acme Corp" --name "Acme Shop" --author "Acme Product Security Team" -o acme-shop.vl.yaml
    Created: acme-shop.vl.yaml

    Name the file vulnlog.yaml, or give it a name that ends in .vl.yaml. init writes any name, but the other commands only read these names and .yml variants.

  2. Replace releases: [] with the releases you support, oldest first:

    releases:
      - id: 4.2.0
        published_at: 2026-03-02
      - id: 4.3.0
        published_at: 2026-06-15

    To list the artifacts of each release, see Add and publish releases.

  3. Validate the file:

    $ vulnlog validate acme-shop.vl.yaml
    info: acme-shop.vl.yaml: releases[4.2.0]: Unreferenced release ID '4.2.0'.
    info: acme-shop.vl.yaml: releases[4.3.0]: Unreferenced release ID '4.3.0'.
    2 infos
    Validated: acme-shop.vl.yaml

    The info lines go away when entries refer to the releases.

  4. Commit the file.

Variants

If you use the Gradle plugin

Run vulnlogInit with the values as project properties, and add the file to the vulnlog block:

$ ./gradlew vulnlogInit -Pvulnlog.organization="Acme Corp" -Pvulnlog.name="Acme Shop" \
    -Pvulnlog.author="Acme Product Security Team" -Pvulnlog.output=acme-shop.vl.yaml
vulnlog {
    files.from("acme-shop.vl.yaml")
}

For the plugin setup, see Gradle plugin.

If you use Docker

Mount the repository to /work:

$ docker run --rm -v "$PWD:/work" ghcr.io/vulnlog/vulnlog:0.19.0 init \
    --organization "Acme Corp" --name "Acme Shop" --author "Acme Product Security Team" -o acme-shop.vl.yaml

For the user ID the container runs as, see Install Vulnlog.

If you support several release lines or products

Keep one file per release line, and one file per product. See Support several release lines.

Check the result

  • vulnlog validate --strict acme-shop.vl.yaml passes.

  • vulnlog fmt --check acme-shop.vl.yaml prints Unchanged: acme-shop.vl.yaml.

To get validation and completion while you edit the file, see Set up your editor. To record your first entry, see Triage a new scanner finding.