Skip to content

Vulnesis/cli/analyze action

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

Updated 03 Nov 2026Markdown

Installs the CLI and runs vulnetix analyze, which reports the repository’s technology stack, ownership and risk, and the repository metrics in analyze metrics.

steps:
  - uses: actions/checkout@v5
  - uses: Vulnesis/cli/analyze@v4
    with:
      org-id: ${{ secrets.VULNESIS_ORG_ID }}
      api-key: ${{ secrets.VULNESIS_API_KEY }}

Runs vulnetix analyze --path <path>. Credentials are optional: without org-id and a credential the CLI runs in community mode. They reach the CLI only as environment variables; see Credentials.

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
org-id Vulnesis organization ID (UUID), used with api-key. Optional: without credentials the CLI runs in community mode -
api-key Vulnesis API key. Passed to the CLI as VULNESIS_API_KEY, never on the command line -
api-token Vulnesis API token; the server resolves the organization. Passed as VULNESIS_API_TOKEN -
path Directory to scan .
args Extra arguments for the command, separated by spaces or newlines (no shell quoting is applied) -
extra-args Extra arguments, one per line, so a value may contain spaces -
artifact-name Upload every file the command wrote as a workflow artifact with this name -
fail-on-findings Fail the step when the command exits non-zero (findings over a gate, a breach, an error): true or false. The artifact, attestation and publish steps run either way true
github-token Token for GitHub publishing, release assets and pull request comments ${{ github.token }}
attest Attest the written files with GitHub artifact attestations (needs id-token: write and attestations: write): true or false false
release-tag Attach every file the command wrote to the GitHub release with this tag (needs contents: write) -

args is split on spaces and newlines. No shell quoting is applied, and nothing is evaluated.

Outputs

Output Description
files Every file the command wrote, one per line
sarif The SARIF files it wrote, one per line
sbom The CycloneDX SBOM it wrote, if any
manifest The artifact manifest (JSON Lines) listing what it wrote
exit-code The command’s exit code
result success or failure
summary One line saying what ran and how it ended

Permissions

  • contents: read to check out the repository
  • id-token: write and attestations: write with attest: true
  • contents: write with release-tag

Example workflow

name: Vulnesis analyze
on:
  schedule:
    - cron: '0 3 * * 1'
  workflow_dispatch:
jobs:
  analyze:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: read
      issues: read
      id-token: write
      attestations: write
    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0
      - uses: Vulnesis/cli/analyze@v4
        with:
          org-id: ${{ secrets.VULNESIS_ORG_ID }}
          api-key: ${{ secrets.VULNESIS_API_KEY }}
          artifact-name: vulnetix-analyze
          attest: true

artifact-name uploads every file the command wrote as one workflow artifact. attest: true attests those files with GitHub artifact attestations.

Behaviour

  • analyze reads pull requests and issues through the GitHub API with github-token, so the job needs pull-requests: read and issues: read as well as the permissions below.
  • Check out with fetch-depth: 0. Ownership and history metrics read the full history.
  • files lists the paths of everything the command wrote, one per line. sarif and sbom narrow that to the SARIF files and the CycloneDX SBOM.

Upload and attest in your own steps

The built-in artifact-name and attest inputs are the short form. To control those steps yourself, use the outputs. The action’s last step fails the job with the command’s exit code, so later steps need if: ${{ !cancelled() }}; the example turns the failure off and re-raises it at the end.

      - uses: Vulnesis/cli/analyze@v4
        id: vulnetix
        with:
          org-id: ${{ secrets.VULNESIS_ORG_ID }}
          api-key: ${{ secrets.VULNESIS_API_KEY }}
          fail-on-findings: false
      - uses: actions/upload-artifact@v7
        if: ${{ !cancelled() }}
        with:
          name: vulnetix-analyze
          path: ${{ steps.vulnetix.outputs.files }}
          include-hidden-files: true
      - uses: actions/attest-build-provenance@v4
        if: ${{ !cancelled() }}
        with:
          subject-path: ${{ steps.vulnetix.outputs.files }}
      - name: Fail on the command's exit code
        if: ${{ steps.vulnetix.outputs.exit-code != '0' }}
        env:
          EXIT_CODE: ${{ steps.vulnetix.outputs.exit-code }}
        run: exit "$EXIT_CODE"

Verify an attestation made this way with gh attestation verify <file> --repo <owner>/<repo>.

See also

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