AIBOM Command Reference

The aibom command discovers evidence of AI coding agents/assistants and AI usage in a project and produces an AI Bill of Materials (AIBOM) in CycloneDX 1.7 format. See AIBOM for what is detected and the catalog format.

Usage

vulnetix aibom [path] [flags]

Flags

FlagTypeDefaultDescription
--pathstring.Directory to scan (a positional [path] argument overrides this)
--depthint25Maximum recursion depth for file discovery
--ignorestringArray-Exclude paths matching glob pattern (repeatable)
-o, --outputstringcyclonedx-jsonOutput format: cyclonedx-json, json, table
--output-filestring-Write output to this file instead of stdout
--spec-versionstring1.7CycloneDX spec version: 1.6 or 1.7
--catalogstring-Catalog file to merge over (or replace) the builtin catalog
--no-builtin-catalogboolfalseDo not load the embedded catalog (use only --catalog)
--no-envboolfalseSkip the environment-variable detection pass
--include-homeboolfalseAlso probe the user’s home directory for tool config dirs
--no-sourceboolfalseSkip the source-code SDK / model detection pass
--no-commitsboolfalseSkip the git commit-history detection pass
--commit-scan-maxint2000Max commits (from HEAD) the commit-history pass inspects
--aibom-include-ignoredboolfalseInclude files matched by .gitignore (default: gitignored paths are skipped)

Output

  • cyclonedx-json (default) — a CycloneDX AIBOM. AI coding tools map to application components, AI SDKs to library components, and model names to machine-learning-model components (each with a modelCard). Evidence rides on component properties under the vulnetix:ai/* namespace. The document is schema-validated before it is written.
  • table — a human-readable summary.
  • json — the raw detection result.

Examples

vulnetix aibom                                  # scan ., emit CycloneDX AIBOM to stdout
vulnetix aibom ./myproject -o table             # human-readable summary
vulnetix aibom --output-file aibom.cdx.json     # write the AIBOM to a file
vulnetix aibom --no-env --no-source             # filesystem evidence only
vulnetix aibom --catalog ./extra-rules.json     # extend the builtin catalog

Inside a scan

vulnetix scan captures the AI inventory as one of its passes, and it calls this command’s pipeline — the same catalog, the same detection passes, the same memory reconcile. The in-scan pass differs only in what it does with the result:

vulnetix aibompass inside vulnetix scan
Passes runselected by --no-env / --no-source / --no-commits / --no-iacall four
CycloneDX file writtenyes (.vulnetix/ai-bom.cdx.json or --output-file)no
Terminal outputyes (-o pretty/json/cyclonedx-json)no
Memory reconcileyesyes
Submitted when authenticatedyes (unless --no-upload)yes

Turn the pass off with vulnetix scan --no-aibom. Run this command directly when you want the file, the table, or control over which passes run.

Privacy

The environment pass records only variable names and their presence — never their values. No source content is uploaded.