Skip to content

Vulnesis/cli/setup action

The Vulnesis/cli/setup GitHub Action: inputs, outputs, permissions and a complete workflow with artifact upload and attestation.

Updated 03 Nov 2026Markdown

Installs the Vulnesis CLI and adds it to PATH for the later steps of the job. It runs no command, takes no credentials and writes no files. Use it when a step needs a vulnetix command that none of the per-command actions covers, or when several run: steps share one install.

steps:
  - uses: actions/checkout@v5
  - uses: Vulnesis/cli/setup@v4

Runs no command.

Inputs

Input Description Default
version Release of the Vulnesis CLI to install. Empty installs the release this action ref was cut from, which is what a lock file or a SHA pin expects. An exact tag (v4.0.0), a major channel (v4) or latest float instead -
binary-path Path to an already-built vulnetix binary to use instead of downloading a release -
verify-provenance Verify the downloaded CLI against the signed SLSA provenance of its release with cosign, which this action installs: true or false. Every v4 release is signed; set false to install a v3 release that has no provenance.sigstore.json. The SHA-256 checksum is checked either way true

Outputs

Output Description
version The installed CLI version

Permissions

  • contents: read to check out the repository

Example workflow

name: Vulnesis
on:
  push:
    branches: [main]
  pull_request:
permissions:
  contents: read
  id-token: write
  attestations: write
jobs:
  scan:
    runs-on: ubuntu-latest
    env:
      VULNESIS_ORG_ID: ${{ secrets.VULNESIS_ORG_ID }}
      VULNESIS_API_KEY: ${{ secrets.VULNESIS_API_KEY }}
    steps:
      - uses: actions/checkout@v5
      - uses: Vulnesis/cli/setup@v4
      - run: vulnetix auth verify
      - name: Scan
        run: |
          mkdir -p dist
          vulnetix scan --fail-on high -o dist/sbom.cdx.json -o dist/results.sarif
      - uses: actions/upload-artifact@v7
        if: ${{ !cancelled() }}
        with:
          name: vulnetix
          path: dist/
          if-no-files-found: warn
      - uses: actions/attest-build-provenance@v4
        if: ${{ hashFiles('dist/sbom.cdx.json') != '' }}
        with:
          subject-path: dist/sbom.cdx.json

Behaviour

  • The binary goes to $RUNNER_TEMP/vulnetix-bin, which is appended to $GITHUB_PATH. The action sets VULNESIS_CLI_INSTALLED in $GITHUB_ENV, so a second Vulnesis action in the same job that asks for the same version skips the download.
  • version takes an exact tag (v4.0.0), a major channel (v4, the newest v4 release) or latest. The default is the channel of the action ref: v4 for @v4, v3 for @v3. See Versions and release channels.
  • binary-path copies a binary you built earlier in the job instead of downloading a release.
  • The installer is the install.sh shipped at the action’s ref. It verifies the binary against the release checksums.
  • Credentials are not inputs here. Give them to the steps that run commands, as env:, so they exist only where they are used.

See also

esc
↑ ↓ move↵ openSearches in your browser. A key like autonomy.max or a code like threshold_required jumps straight to it.