# Environment variables

Every environment variable the vulnetix binary reads for credentials, endpoints, labels, output, caches, tuning and debugging, with defaults.

Flags win over environment variables wherever both exist. Variables used only by one product's commands (the runtime sensor, the SIEM forwarder, the AI Firewall) are documented in that product's segment.

## Credentials

Read in this order; the first complete source wins. See [Credential precedence](/cli/authentication/precedence.md).

| Variable | Meaning |
|---|---|
| `VULNESIS_API_TOKEN` | Bearer token. Outranks every other source. |
| `VULNESIS_API_KEY` | ApiKey. Used only together with `VULNESIS_ORG_ID`. A leading `<org>:` is stripped. |
| `VULNESIS_ORG_ID` | Organisation UUID for the ApiKey, and the `--noninteractive` login org. It never names a manufacturer: when a manufacturer name resolves, the id is written as `metadata.manufacturer.bom-ref` (`urn:uuid:<id>`). |
| `VVD_ORG`, `VVD_SECRET` | SigV4 organisation and secret. Used only as a pair. |
| `VULNESIS_CREDENTIALS_DIR` | Directory of the home credentials file instead of `~/.vulnetix` (read and write) |

## Endpoints

| Variable | Default | Meaning |
|---|---|---|
| `VULNESIS_API_URL` | `https://api-vdb.vulnes.is` | VDB API base for `scan` and the language server, for a mock or self-hosted API. `upload --base-url` sets it for that run. |
| `VULNESIS_WEB_URL` | `https://www.vulnes.is` | Site base for the browser login's device endpoints |
| `GITHUB_API_URL` | `https://api.github.com` | GitHub API for `gha upload` and the `gha` posture commands (GitHub Enterprise Server) |

## GitHub

| Variable | Read by |
|---|---|
| `GITHUB_TOKEN` | `gha upload` (required to list the run's artifacts), `analyze`, `gha` posture commands, `triage`, licence lookups |
| `GH_TOKEN` | `analyze`, `gha` posture commands, `triage`, licence lookups, after `GITHUB_TOKEN`. Then `gh auth token`. |
| `GITHUB_REPOSITORY`, `GITHUB_RUN_ID`, `GITHUB_RUN_ATTEMPT` | `gha upload` and `gha status` (the run to read), `gha` posture commands (`--repo` default) |
| `GITHUB_STEP_SUMMARY` | `scan` appends a Markdown summary when set |
| `GITHUB_ACTIONS`, `GITLAB_CI`, `CI_JOB_ID`, `TF_BUILD`, `BITBUCKET_BUILD_NUMBER`, `JENKINS_URL`, `BUILD_NUMBER`, `KUBERNETES_SERVICE_HOST`, ... | Platform detection; see [env](/cli/commands/utilities.md#env) |

## Deployment labels and BOM identity

Fallbacks for the flags of the `scan` family, `cdx`, `aibom` and `cbom`. A flag wins over its variable; for a label, the first variable set wins. See [scan](/cli/commands/scan.md#deployment-context-and-bom-identity) and [Author and customise](/sbom/author/overview.md#environment-variables).

| Variable | Flag |
|---|---|
| `VULNESIS_PROJECT`, then `CI_PROJECT_NAME` | `--project` |
| `VULNESIS_ENVIRONMENT`, then `CI_ENVIRONMENT_NAME`, `ENVIRONMENT_NAME` | `--environment` |
| `VULNESIS_CLUSTER`, then `CLUSTER_NAME`, `KUBERNETES_CLUSTER_NAME` | `--cluster` |
| `VULNESIS_NAMESPACE`, then `POD_NAMESPACE`, `KUBERNETES_NAMESPACE` | `--namespace` |
| `VULNESIS_BOM_MANUFACTURER` | `--bom-manufacturer` |
| `VULNESIS_BOM_MANUFACTURER_URL` | `--bom-manufacturer-url` |
| `VULNESIS_BOM_AUTHORS` | `--bom-author` (comma- or semicolon-separated) |
| `VULNESIS_BOM_SUPPLIER`, `VULNESIS_BOM_SUPPLIER_URL` | `--bom-supplier`, `--bom-supplier-url` |
| `VULNESIS_BOM_SERIAL`, `VULNESIS_BOM_VERSION` | `--bom-serial`, `--bom-version` |
| `VULNESIS_BOM_LICENSES`, `VULNESIS_BOM_PROPERTIES`, `VULNESIS_BOM_OVERLAY` | `--bom-license`, `--bom-property`, `--bom-overlay` (comma- or semicolon-separated) |
| `VULNESIS_COMPONENT_NAME`, `_VERSION`, `_TYPE`, `_GROUP`, `_PURL` | `--component-name`, `-version`, `-type`, `-group`, `-purl` |

## Output, banner and analytics

| Variable | Effect |
|---|---|
| `CI=true` | No banner; no analytics unless also under GitHub Actions; superseded-flag notes are not printed |
| `DO_NOT_TRACK=1` | No banner, no analytics, no install-script ping |
| `VULNESIS_NO_ANALYTICS` | Any value: no analytics. `1`: no install-script ping. |
| `VULNESIS_ARTIFACT_MANIFEST` | Path of the [artifact manifest](/cli/reference/artifact-manifest.md), as `--artifact-manifest` |
| `NO_COLOR` | No colour (as `--color never`) |
| `COLUMNS` | Output width when not a terminal and `--width` is not set |

## Caches

| Variable | Default location | Effect |
|---|---|---|
| `VULNESIS_SAST_CACHE_DIR` | `<user cache dir>/vulnetix/sast` | SAST rule-result cache; point a CI cache step here. `--no-cache` turns it off. |
| `VULNESIS_GRAPH_CACHE_DIR` | `<user cache dir>/vulnetix/graph` | Per-file graph facts cache for `analyze` and scans |
| `VULNESIS_MALSCAN_DEFS_DIR` | `<user cache dir>/vulnetix/malscan/definitions` | Malscan threat-intel definitions |
| `VULNESIS_NO_TOKEN_CACHE` | `~/.vulnetix/cache/tokens` | Any value: do not keep SigV4 tokens on disk |
| `VULNESIS_NO_LICENSE_CACHE` | `~/.vulnetix/cache/licenses` | Any value: do not keep licence lookups |
| `VULNESIS_NO_BINARY_CACHE` | `~/.vulnetix/cache/binaries` | Any value: do not keep binary version detections |

`<user cache dir>` is `~/.cache` on Linux (or `$XDG_CACHE_HOME`), `~/Library/Caches` on macOS and `%LocalAppData%` on Windows. VDB responses are cached under `~/.vulnetix/cache/vdb/`, one directory per CLI version; old versions are cleaned at start.

## Tuning

| Variable | Default | Effect |
|---|---|---|
| `VULNESIS_SCA_CONCURRENCY` | `6` (1 to 16) | Parallel `cli.sca` requests |
| `VULNESIS_SCA_TIMEOUT` | `75` seconds (10 to 300) | Per-request limit for `cli.sca` |
| `VULNESIS_SAST_WORKERS` | CPU count | Concurrent rule evaluations |
| `VULNESIS_SAST_SHARDS` | by CPU count and rule count | Concurrent compile and evaluate shards; `1` compiles once |
| `VULNESIS_SAST_NO_LANG_FILTER` | unset | Any value: run rules for languages absent from the repository too |
| `VULNESIS_REACHABILITY_CONCURRENCY` | CPU count (1 to 32) | Files analysed in parallel by reachability |
| `VULNESIS_GRAPH_WORKERS` | CPU count | Parallel file parsing for the graph |
| `GOMEMLIMIT` | 75% of the cgroup `memory.max` or physical memory | A scan sets a soft Go memory limit so the GC works harder before the kernel kills it. An explicit `GOMEMLIMIT` wins. |

## Debugging

| Variable | Effect |
|---|---|
| `VULNESIS_HTTP_TRACE` | Any value: one stderr line per VDB request with start offset, duration, status, method, URL and connection setup time, e.g. `[http#5] + 2241ms 3836ms 200 POST api-vdb.vulnes.is/v2/cli.sca net=0ms` |
| `VULNESIS_PPROF_DIR` | Write `cpu.pprof` (and other profiles) for the run into this directory |

## Install script

| Variable | Default | Effect |
|---|---|---|
| `INSTALL_DIR` | `/usr/local/bin` | Same as `--install-dir` |
| `VERSION` | `latest` | Same as `--version` |
