cli

command module
v3.84.10 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 2, 2026 License: AGPL-3.0 Imports: 2 Imported by: 0

README

Pix, the Vulnetix AI coding assistant

Vulnetix CLI & GitHub Action

Automated vulnerability management for your CI/CD pipelines and development workflows.

Contents


GitHub Action

This GitHub Action provides the Vulnetix CLI for your workflows, enabling automated vulnerability scanning directly in your CI/CD pipeline.

Basic Usage
- name: Vulnetix Scan
  uses: Vulnetix/cli@v3.59.4
  with:
    org-id: ${{ secrets.VULNETIX_ORG_ID }}
    api-key: ${{ secrets.VULNETIX_API_KEY }}
Workflow Examples
Scan on Pull Request
name: Security Scan
on: [pull_request]
permissions:
  contents: read

jobs:
  vulnetix:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-go@v6
        with:
          go-version: stable
      - uses: Vulnetix/cli@v3.59.4
        with:
          org-id: ${{ secrets.VULNETIX_ORG_ID }}
          api-key: ${{ secrets.VULNETIX_API_KEY }}
Upload Artifacts
- uses: Vulnetix/cli@v3.59.4
  with:
    org-id: ${{ secrets.VULNETIX_ORG_ID }}
    api-key: ${{ secrets.VULNETIX_API_KEY }}
    task: upload
    artifact-path: ./reports/

See GitHub Actions documentation for complete configuration options, and Artifact Upload guide for uploading workflow artifacts to Vulnetix.

Other CI/CD Platforms
Platform Guide
GitLab CI GitLab pipeline integration
Azure DevOps Azure pipeline integration
Bitbucket Bitbucket pipeline integration

Claude Code Plugin

Integrate Vulnetix vulnerability intelligence directly into Claude Code with automated pre-commit scanning, six interactive analysis skills, and multi-hook architecture.

Install

Add the marketplace:

/plugin marketplace add Vulnetix/pix-ai-coding-assistant

Install the plugin:

/plugin install vulnetix@vulnetix-plugins
Upgrade
/plugin update vulnetix

Requires: Vulnetix CLI installed and authenticated (vulnetix auth login).

Full plugin documentation | Plugin repository


CLI Installation

Method Platforms Installation
Install Script Linux, macOS curl -fsSL https://cli.vulnetix.com/install.sh | sh
Homebrew Linux, macOS brew install vulnetix/tap/vulnetix
Scoop Windows scoop install vulnetix
Nix Linux, macOS nix profile install github:Vulnetix/cli
Go Install All go install github.com/vulnetix/cli/v3@latest
Binary Download All Direct download
From Source All Build from source

Architecture support: AMD64, ARM64, ARM, 386.

Quick Start
brew install vulnetix/tap/vulnetix
vulnetix auth login
vulnetix vdb status

See CLI Documentation for complete usage and command reference.


Available Tasks

Task Description Use Case
info Auth healthcheck (default) Verify credential setup

Using the CycloneDX Go Module

Other Go projects can generate the same Vulnetix CycloneDX document shape by importing github.com/Vulnetix/vdb-cyclonedx directly:

package main

import (
	"os"

	cyclonedx "github.com/Vulnetix/vdb-cyclonedx"
)

func main() {
	bom, err := cyclonedx.BuildSBOM(cyclonedx.SBOMInventory{
		Packages: []cyclonedx.SBOMPackage{{
			Name:       "example",
			Version:    "1.2.3",
			Ecosystem:  "golang",
			Scope:      "production",
			SourceFile: "go.mod",
			SourceType: "manifest",
			IsDirect:   true,
		}},
	}, cyclonedx.SBOMOptions{
		SpecVersion: "1.7",
		ToolName:    "my-builder",
		ToolVersion: "1.0.0",
	})
	if err != nil {
		panic(err)
	}
	_ = os.WriteFile("sbom.cdx.json", bom, 0o644)
}

BuildSBOM can also merge AIDetections and CryptoDetections so a single CycloneDX file carries package SBOM, AIBOM and CBOM components, accepts a resolved dependency graph via SBOMInventory.Dependencies, and takes an optional SBOMOptions.CanonicalSPDXID hook so recognised licenses are emitted as license.id instead of free text. The builder validates the output against the bundled CycloneDX schema before returning JSON.

vulnetix cdx (alias vulnetix sbom) is the CLI front end for this: it discovers packages from manifests, installed package trees, container package databases, Dockerfiles, CI/CD pipeline files, shell scripts and the metadata compiled into Go, Rust and JVM artefacts, then writes one validated CycloneDX file offline.


Documentation

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
aibom
Package aibom discovers evidence of AI coding agents and AI-SDK usage in a codebase and maps it to a CycloneDX AI Bill of Materials.
Package aibom discovers evidence of AI coding agents and AI-SDK usage in a codebase and maps it to a CycloneDX AI Bill of Materials.
aibom/aibomgen command
Command aibomgen renders the AIBOM detection documentation from the single source of truth: the embedded catalog (internal/aibom/catalog/*.json).
Command aibomgen renders the AIBOM detection documentation from the single source of truth: the embedded catalog (internal/aibom/catalog/*.json).
analytics
Package analytics provides Google Analytics 4 (GA4) Measurement Protocol integration for server-side event tracking from the Vulnetix CLI.
Package analytics provides Google Analytics 4 (GA4) Measurement Protocol integration for server-side event tracking from the Vulnetix CLI.
analyze
Package analyze produces the `vulnetix analyze` report: a repository's tech-stack graph, the cross-repo join keys other repositories match against, and the metrics for that repository — each metric carrying the evidence that produced it.
Package analyze produces the `vulnetix analyze` report: a repository's tech-stack graph, the cross-repo join keys other repositories match against, and the metrics for that repository — each metric carrying the evidence that produced it.
analyze/forge
Package forge talks to the code-hosting platform — today, GitHub.
Package forge talks to the code-hosting platform — today, GitHub.
binpkg
Package binpkg discovers packages from compiled artefacts — the case where a dependency exists in a container image or release archive but no manifest, lockfile or package database mentions it.
Package binpkg discovers packages from compiled artefacts — the case where a dependency exists in a container image or release archive but no manifest, lockfile or package database mentions it.
cbom
Package cbom discovers cryptographic usage in a codebase — in source, config, certificates/keys on disk and declared crypto libraries — and maps it to a CycloneDX Cryptography Bill of Materials, classifying each algorithm for post-quantum posture (quantum-safe | quantum-vulnerable | deprecated | hybrid).
Package cbom discovers cryptographic usage in a codebase — in source, config, certificates/keys on disk and declared crypto libraries — and maps it to a CycloneDX Cryptography Bill of Materials, classifying each algorithm for post-quantum posture (quantum-safe | quantum-vulnerable | deprecated | hybrid).
cbom/cbomgen command
Command cbomgen renders the CBOM detection documentation from the single source of truth: the embedded catalog (internal/cbom/catalog/*.json).
Command cbomgen renders the CBOM detection documentation from the single source of truth: the embedded catalog (internal/cbom/catalog/*.json).
cdx
ecosystems
Package ecosystems resolves the on-disk locations where a project's dependencies are installed/cached, per programming-language / package-manager ecosystem.
Package ecosystems resolves the on-disk locations where a project's dependencies are installed/cached, per programming-language / package-manager ecosystem.
fix
ghactx
Package ghactx collects the CI identity of a GitHub Actions run.
Package ghactx collects the CI identity of a GitHub Actions run.
ghasetup
Package ghasetup wires third-party security scanners into a repository's GitHub Actions workflows.
Package ghasetup wires third-party security scanners into a repository's GitHub Actions workflows.
ghasetup/ghasetupgen command
Command ghasetupgen renders the third-party scanner documentation from the single source of truth: the embedded catalog (internal/ghasetup/catalog).
Command ghasetupgen renders the third-party scanner documentation from the single source of truth: the embedded catalog (internal/ghasetup/catalog).
ignore
Package ignore implements .gitignore-style path matching shared by the scan and sast filesystem walkers.
Package ignore implements .gitignore-style path matching shared by the scan and sast filesystem walkers.
managedfile
Package managedfile writes and reverts Vulnetix-owned regions of a user's config files without disturbing the rest of the file.
Package managedfile writes and reverts Vulnetix-owned regions of a user's config files without disturbing the rest of the file.
memory
Package memory manages the .vulnetix/memory.yaml file that persists scan state between runs — last scan summary, history, and cached findings.
Package memory manages the .vulnetix/memory.yaml file that persists scan state between runs — last scan summary, history, and cached findings.
reachability
Package reachability runs tree-sitter S-expression queries supplied by vdb-manager against source files to determine whether a known- vulnerable code pattern is present (direct mode) or reachable from first-party code (transitive mode).
Package reachability runs tree-sitter S-expression queries supplied by vdb-manager against source files to determine whether a known- vulnerable code pattern is present (direct mode) or reachable from first-party code (transitive mode).
sast/secretsgen command
Command secretsgen renders the high-fidelity secret-detection rule set and its documentation from a single source of truth: catalog.json.
Command secretsgen renders the high-fidelity secret-detection rule set and its documentation from a single source of truth: catalog.json.
secretscan
Package secretscan provides binary file inspection and git history scanning helpers used by the secrets detection stage.
Package secretscan provides binary file inspection and git history scanning helpers used by the secrets detection stage.
suppress
Package suppress holds the shared "ignore rule" matching logic used by every scanner pipeline (SAST family, SCA, license, malscan) to drop findings that an org-level or local Suppression covers, before report output is generated.
Package suppress holds the shared "ignore rule" matching logic used by every scanner pipeline (SAST family, SCA, license, malscan) to drop findings that an org-level or local Suppression covers, before report output is generated.
suppressdrift
Package suppressdrift relocates code-anchored suppressions (nosec directives and file/line ignore rules) as the code they pin to moves through git history.
Package suppressdrift relocates code-anchored suppressions (nosec directives and file/line ignore rules) as the code they pin to moves through git history.
testsuite
Package testsuite detects whether a source-code finding lives in a project's test suite, and identifies the testing framework responsible.
Package testsuite detects whether a source-code finding lives in a project's test suite, and identifies the testing framework responsible.
treesitter
Package treesitter wires the vdb-manager language identifiers used in x_treeSitterQueries.language to concrete tree-sitter grammars bundled via github.com/smacker/go-tree-sitter.
Package treesitter wires the vdb-manager language identifiers used in x_treeSitterQueries.language to concrete tree-sitter grammars bundled via github.com/smacker/go-tree-sitter.
triage
Package triage provides a provider abstraction for fetching vulnerability alerts from external sources (GitHub Dependabot, Snyk, etc.) and enriching them with VDB remediation data.
Package triage provides a provider abstraction for fetching vulnerability alerts from external sources (GitHub Dependabot, Snyk, etc.) and enriching them with VDB remediation data.
tui
versions
Package versions provides SemVer-aware version parsing, comparison, range evaluation, and CVE 5.1 affected/unaffected status determination.
Package versions provides SemVer-aware version parsing, comparison, range evaluation, and CVE 5.1 affected/unaffected status determination.
pkg
aifirewall
Package aifirewall wires local AI clients to the Vulnetix AI Firewall gateway and reconciles the org's gateway policy.
Package aifirewall wires local AI clients to the Vulnetix AI Firewall gateway and reconciles the org's gateway policy.
tea
Package tea is a client for the OWASP Transparency Exchange API.
Package tea is a client for the OWASP Transparency Exchange API.
tty
vdb
third_party

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL