CLI Command Reference

Audience: DevEx engineers, operators, and CI authors integrating the stella CLI into vulnerability-scanning and release-control workflows. Scope: Synopsis, options, exit codes, and offline notes for the AOC, lock-validation, knowledge-search, policy-lifecycle, and verification command families.

The commands in this reference enforce the AOC guardrails described in the Aggregation-Only Contract reference and the CLI architecture overview. They consume Authority-issued tokens with tenant scopes and never mutate ingestion stores.

For per-command deep dives, see the commands/ guides. For the canonical exit-code contract, see Output and exit codes.

1 · Prerequisites

• CLI version: stella ≥ 0.19.0 (AOC feature gate enabled).
• Required scopes (DPoP-bound):
  • advisory:read for Concelier sources.
  • vex:read for Excititor sources (optional but required for VEX checks).
  • aoc:verify to invoke guard verification endpoints.
  • tenant:select if your deployment uses tenant switching.
• Connectivity: direct access to Concelier/Excititor APIs or an Offline Kit snapshot (see the offline notes in each section).
• Environment: set STELLA_AUTHORITY_URL, STELLA_TENANT, and export a valid OpTok via stella auth login or an existing token cache.

2 · AdvisoryAI knowledge search

The AdvisoryAI Knowledge Search (AKS) commands expose deterministic retrieval from AdvisoryAI (docs|api|doctor) without requiring an LLM.

2.1 stella search

stella search "<query>" \
  [--type docs|api|doctor] \
  [--product <product>] \
  [--version <version>] \
  [--service <service>] \
  [--tag <tag>] \
  [--k <1-100>] \
  [--json]

Notes:

• --type and --tag are repeatable or comma-separated.
• --json emits a stable, machine-readable payload with results[].open.

2.2 stella doctor suggest

stella doctor suggest "<symptom-or-error>" \
  [--product <product>] \
  [--version <version>] \
  [--k <1-100>] \
  [--json]

Uses the same AKS index and prints grouped recommendations for:

• Doctor checks (with run command).
• Related docs anchors.
• Related API operations.

2.3 stella advisoryai index rebuild

stella advisoryai index rebuild [--json]

Rebuilds the deterministic AKS index from local markdown, OpenAPI, and Doctor metadata sources.

2.4 stella advisoryai sources prepare

stella advisoryai sources prepare \
  [--repo-root <path>] \
  [--docs-allowlist <path>] \
  [--docs-manifest-output <path>] \
  [--openapi-output <path>] \
  [--doctor-seed <path>] \
  [--doctor-controls-output <path>] \
  [--overwrite] \
  [--json]

Generates deterministic AKS seed artifacts before an index rebuild:

• docs manifest from the allow-list
• aggregated OpenAPI artifact output path
• doctor controls projection JSON, enriched from the configured seed plus discovered Doctor check catalog metadata when available

3 · stella sources ingest --dry-run

3.1 Synopsis

stella sources ingest --dry-run \
  --source <source-key> \
  --input <path-or-uri> \
  [--tenant <tenant-id>] \
  [--format json|table] \
  [--no-color] \
  [--output <file>]

3.2 Description

Previews an ingestion write without touching the database. The command loads an upstream advisory or VEX document, computes the would-write payload, runs it through the AOCWriteGuard, and reports any forbidden fields, provenance gaps, or idempotency issues. Use it during connector development, CI validation, or while triaging incidents.

3.3 Options

3.4 Output schema (JSON)

{
  "source": "redhat",
  "tenant": "default",
  "guardVersion": "1.0.0",
  "status": "ok",
  "document": {
    "contentHash": "sha256:…",
    "supersedes": null,
    "provenance": {
      "signature": { "format": "pgp", "present": true }
    }
  },
  "violations": []
}

When violations exist, status becomes error and violations contains entries with code (ERR_AOC_00x), a short message, and JSON Pointer path values indicating the offending fields.

3.5 Exit codes

Exit codes map directly to the ERR_AOC_00x table for scripting consistency. Multiple violations yield the highest-priority code (e.g., 11 takes precedence over 14).

3.6 Examples

Dry-run a local CSAF file:

stella sources ingest --dry-run \
  --source redhat \
  --input ./fixtures/redhat/RHSA-2025-1234.json

Stream from HTTPS and emit JSON for CI:

stella sources ingest --dry-run \
  --source osv \
  --input https://osv.dev/vulnerability/GHSA-aaaa-bbbb \
  --format json \
  --output artifacts/osv-dry-run.json

cat artifacts/osv-dry-run.json | jq '.violations'

3.7 Offline notes

When operating in sealed/offline mode:

• Use --input paths pointing to Offline Kit snapshots (offline-kit/advisories/*.json).
• Provide --tenant explicitly if the offline bundle contains multiple tenants.
• The command does not attempt network access when given a file path.
• Store reports with --output to include in transfer packages for policy review.

4 · stella aoc verify

4.1 Synopsis

stella aoc verify \
  [--since <iso8601|duration>] \
  [--limit <count>] \
  [--sources <list>] \
  [--codes <ERR_AOC_00x,...>] \
  [--format table|json] \
  [--export <file>] \
  [--tenant <tenant-id>] \
  [--no-color]

4.2 Description

Replays the AOC guard against stored raw documents. By default it checks all advisories and VEX statements ingested in the last 24 hours for the active tenant, reporting totals, top violation codes, and sample documents. Use it in CI pipelines, scheduled verifications, or during incident response.

4.3 Options

table mode prints a summary showing the active tenant, evaluated window, counts of checked advisories/VEX statements, the active limit, total writes/violations, and whether the page was truncated. Status is colour-coded as ok, violations, or truncated. When violations exist, the detail table lists the code, total occurrences, first sample document (source + documentId + contentHash), and JSON Pointer path.

4.4 Report structure (JSON)

{
  "tenant": "default",
  "window": {
    "from": "2025-10-25T12:00:00Z",
    "to": "2025-10-26T12:00:00Z"
  },
  "checked": {
    "advisories": 482,
    "vex": 75
  },
  "violations": [
    {
      "code": "ERR_AOC_001",
      "count": 2,
      "examples": [
        {
          "source": "redhat",
          "documentId": "advisory_raw:redhat:RHSA-2025:1",
          "contentHash": "sha256:…",
          "path": "/content/raw/cvss"
        }
      ]
    }
  ],
  "metrics": {
    "ingestion_write_total": 557,
    "aoc_violation_total": 2
  },
  "truncated": false
}

4.5 Exit codes

4.6 Examples

Daily verification across all sources:

stella aoc verify --since 24h --format table

CI pipeline focusing on errant sources and exporting evidence:

stella aoc verify \
  --sources redhat,ubuntu \
  --codes ERR_AOC_001,ERR_AOC_004 \
  --format json \
  --limit 100 \
  --export artifacts/aoc-verify.json

jq '.violations[] | {code, count}' artifacts/aoc-verify.json

Air-gapped verification using an Offline Kit snapshot (example script):

stella aoc verify \
  --since 7d \
  --format json \
  --export /mnt/offline/aoc-verify-$(date +%F).json

sha256sum /mnt/offline/aoc-verify-*.json > /mnt/offline/checksums.txt

4.7 Automation tips

• Schedule with cron or a platform scheduler and fail the job when the exit code ≥ 11.
• Pair with stella sources ingest --dry-run for pre-flight validation before re-enabling a paused source.
• Push JSON exports to observability pipelines for historical tracking of violation counts.

4.8 Offline notes

• Works against Offline Kit PostgreSQL snapshots when the CLI is pointed at the local API gateway included in the bundle.
• When fully disconnected, run against exported aoc verify reports generated in production and replay them using --format json --export (automation recipe above).
• Include verification output in compliance packages alongside Offline Kit manifests.

5 · stella node lock-validate

5.1 Synopsis

stella node lock-validate \
  [--path <directory>] \
  [--format table|json] \
  [--verbose]

5.2 Description

Runs the Node analyzer locally against a working directory to compare lockfiles (package-lock.json, pnpm-lock.yaml, yarn.lock) with what is actually present in node_modules. The command is read-only and never schedules a scan; it reuses the same deterministic collector that powers Scanner so results match backend evidence. Output highlights two conditions that policy cares about:

• Declared Only – packages present in lockfiles but missing from the filesystem or final image.
• Missing Lock – packages discovered at runtime without corresponding lock metadata (no registry provenance, integrity hash, or repository information).

This helps catch drift before images are built, keeps lockfiles trustworthy, and feeds policy predicates such as node.lock.declaredMissing.

5.3 Options

5.4 Output & exit codes

• table mode prints a summary row and two sections: Declared Only (red) and Missing Lock (yellow). Columns show package, version, lock source/locator, and filesystem path so engineers can reconcile quickly.
• json mode emits { declaredOnly: [], missingLockMetadata: [], totalDeclared, totalInstalled }, mirroring the analyzer telemetry.

Exit codes:

The CLI also records stellaops.cli.node.lock_validate.count{outcome} so operators can monitor adoption in telemetry.

5.5 Offline notes

• Works entirely offline; point --path at a workspace checked out from an Offline Kit or build cache.
• Honors the same Surface.Validation limits configured for Scanner once those knobs (scanner.lockfiles.node.*) are deployed cluster-wide.
• Combine with stella scan by running lock validation in CI before images are built to fail fast on inconsistent manifests.

6 · stella python lock-validate

6.1 Synopsis

stella python lock-validate \
  [--path <directory>] \
  [--format table|json] \
  [--verbose]

6.2 Description

Validates Python lockfiles (currently requirements*.txt, Pipfile.lock, and poetry.lock) against what exists in site-packages. It uses the same analyzer Scanner runs, so declared-only packages, missing locks, and editable installs are detected deterministically and without internet access. This catches drift between lock manifests and baked images before scanners or policy gates fail later.

6.3 Options

6.4 Output & exit codes

Output shape mirrors the Node command: declared-only packages are shown with lock provenance, and runtime packages missing lock metadata are highlighted separately. JSON mode returns the same object schema { declaredOnly, missingLockMetadata, totalDeclared, totalInstalled }.

Exit codes follow the same contract (0 success, 1 violations, 71 for an unreadable path). Telemetry is published via stellaops.cli.python.lock_validate.count{outcome}.

6.5 Offline notes

• Works entirely offline — lockfiles and site-packages must already be present (from a venv snapshot, container rootfs, or Offline Kit).
• Honors upcoming scanner.lockfiles.python.* guardrails once Surface.Validation is wired in, so the CLI and Scanner enforce the same registry/size limits.
• Recommended CI flow: run stella python lock-validate before building containers and fail fast when declared-only packages remain.

7 · stella java lock-validate

7.1 Synopsis

stella java lock-validate \
  [--path <directory>] \
  [--format table|json] \
  [--verbose]

7.2 Description

Executes the Java language analyzer locally so Gradle gradle.lockfile, gradle/dependency-locks/**/*.lockfile, and pom.xml declarations can be compared with the jars that actually ship in a workspace. The command reuses the JavaLockFileCollector plus the JavaLanguageAnalyzer merge logic, so it emits the same DeclaredOnly and Missing Lock evidence that Scanner and Policy consume. Engineers can see which coordinates exist only in lockfiles (no jar on disk) and which installed jars lack lock metadata (no repository/provenance) before a scan ever runs.

7.3 Options

7.4 Output & exit codes

Output mirrors the Node/Python verbs: Declared Only rows include the lock source/locator (e.g., gradle.lockfile, gradle/dependency-locks/app.lockfile) plus configuration/repository hints, while Missing Lock rows highlight jars that Scanner would tag with lockMissing=true. JSON responses return { declaredOnly, missingLockMetadata, totalDeclared, totalInstalled }.

Exit codes align with the other lock validators:

Telemetry is recorded via stellaops.cli.java.lock_validate.count{outcome} so adoption can be monitored alongside the Node/Python verbs.

7.5 Offline notes

• Works with any workspace (Gradle, Maven, or extracted container layers) — no network access or build-tool metadata is required at runtime.
• Honors forthcoming scanner.lockfiles.java.* Surface.Validation limits once they are deployed, so the CLI and Scanner stay in lockstep.
• Recommended CI flow: run stella java lock-validate before packaging containers to surface missing locks / declared-only coordinates early.

8 · stella vuln observations (overlay paging)

stella vuln observations lists raw advisory observations for downstream overlays (Graph Explorer, Policy simulations, Console). Large tenants can page through results deterministically.

Additional notes:

• Table mode prints a hint when hasMore is true: [yellow]More observations available. Continue with --cursor <token>[/].
• JSON mode returns nextCursor and hasMore alongside the observation list so automation can loop until hasMore is false.
• Supplying a non-positive limit falls back to the default (200). Invalid/expired cursors yield 400 Bad Request; restart without --cursor to begin a fresh iteration.

9 · Aggregation-only exit-code reference

Use these codes in CI to map outcomes to build statuses or alert severities.

10 · Policy lifecycle quick start

• stella policy submit --policy <id> --version <n> --attach <simulation.json> --reviewers group
• stella policy review --policy <id> --version <n> --request-changes|--approve
• stella policy approve --policy <id> --version <n> --note "<justification>"
• stella policy publish --policy <id> --version <n> --reason "<why>" --ticket SEC-2048 --sign
• stella policy promote --policy <id> --version <n> --environment stage --note "<context>"
• stella policy activate --policy <id> --version <n> --note "<deployment reason>"

All publish/promote operations require interactive identities with policy:publish/policy:promote and inject attestation metadata headers (policy_reason, policy_ticket, policy_digest). See Policy Lifecycle & Approvals § 3–4 for the full workflow and compliance checklist.

11 · Authority configuration quick reference

Tokens requesting orch:operate fail with invalid_request unless both operator values are present. orch:quota tokens require quota_reason (≤256 chars) and accept an optional quota_ticket (≤128 chars). orch:backfill tokens require both backfill_reason (≤256 chars) and backfill_ticket (≤128 chars). Avoid embedding secrets in any value.

12 · stella excititor verify

12.1 Synopsis

stella excititor verify \
  [--export-id <id>] \
  [--digest <sha256>] \
  [--attestation <path>] \
  [--verbose]

At least one of --export-id, --digest, or --attestation must be supplied.

12.2 Description

Submits an artifact, digest, or attestation bundle to the Attestor service for verification. The command is available once the non-core plugin pack is installed (default in production CLI builds). It validates DSSE envelopes, Rekor proofs, and export digests without requiring operators to call Attestor APIs directly.

12.3 Options

Behaviour: When --attestation is used, the CLI loads the file into memory, encodes it as base64, and delegates verification to Attestor. Verification fails fast if the file cannot be read.

12.4 Secret rule bundle workflow

To confirm the signed secret-leak rule bundle before enabling the analyzer:

export STELLA_ATTESTOR_URL=https://attestor.internal.example      # or Offline Kit mirror

RULES_PATH=offline/rules/secrets/2025.11/secrets.ruleset.rules.jsonl
ATTESTATION_PATH=offline/rules/secrets/2025.11/secrets.ruleset.dsse.json

stella excititor verify \
  --attestation "${ATTESTATION_PATH}" \
  --digest "$(sha256sum "${RULES_PATH}" | cut -d' ' -f1)"

The Attestor response prints verification status, Rekor UUID (when available), and whether the transparency proof was validated.

12.5 Offline considerations

• Point the CLI to the Offline Kit Attestor mirror via STELLA_ATTESTOR_URL (and STELLA_AUTHORITY_URL if using sealed Authority).
• Offline kits include the mirrored Rekor log bundle required by Attestor; the CLI does not need direct Rekor connectivity.
• Always pass --digest when verifying bundles copied through removable media so mismatched payloads are detected locally before Attestor validation.

13 · stella scan entrytrace --stream-ndjson

13.1 Synopsis

stella scan entrytrace \
  --scan-id <scanId> \
  [--stream-ndjson] \
  [--include-ndjson] \
  [--verbose]

13.2 Description

Streams the EntryTrace NDJSON produced by a completed scan. When --stream-ndjson is set, the CLI sends Accept: application/x-ndjson and writes the raw lines to stdout in order, suitable for piping into AOC/ETL tools. Without the flag, the command returns the JSON envelope (scanId, imageDigest, graph, NDJSON array) and optionally prints NDJSON when --include-ndjson is set.

13.3 Examples

Stream raw NDJSON for further processing:

stella scan entrytrace --scan-id scan-123 --stream-ndjson > entrytrace.ndjson

Retrieve the JSON envelope (default behaviour):

stella scan entrytrace --scan-id scan-123

14 · Related references

• Aggregation-Only Contract reference
• Platform architecture overview
• Console operator guide
• Authority scopes
• Task Pack CLI profiles
• Output and exit codes

Last updated: 2025-11-05 (Sprint 101).