Skip to main content

Global Flags Reference for the Vibgrate CLI

A reference for the flags that apply across Vibgrate CLI commands, including path selection, output control, and quiet mode. Learn what each common flag does and when to reach for it.

Vibgrate Docs

Vibgrate Help

This reference covers the flags you can reuse across many Vibgrate CLI commands. It is written for developers who already run scans and want a quick lookup for common options. For command-specific behavior, see the individual command help pages.

How flags work

The installed binary is vg. Because scan is the default subcommand, a bare invocation scans the current directory:

vg

Flags are appended after the command. You never pass a trailing path argument for the current directory.

vg scan --format sarif

Commonly reused flags

  • --cwd — Run as if the CLI were invoked from a different working directory.
  • --format — Choose an output format where the command supports it (see the Output Formats guide).
  • --out — Write output to a file instead of the terminal.
  • --json — Emit machine-readable JSON.
  • --quiet — Reduce console output to essentials; useful in scripts.
  • --offline — Run without network access, using only local artifacts and caches.
  • --no-cache — Bypass cached results and recompute.
  • --yes — Skip interactive confirmation prompts.
  • --version — Print the installed CLI version.
  • --exclude — Exclude paths or patterns from analysis.
  • --concurrency / --jobs — Tune parallelism for large repositories.

Quality-gate flags on scan

The vg scan command adds gate flags that influence the exit code:

vg scan --fail-on error
vg scan --drift-budget 60

These let CI pipelines fail a build when drift exceeds a threshold. See the Exit Codes reference for how gates map to exit statuses.

Notes

Not every flag applies to every command. If a flag is not accepted by a command, the CLI will tell you. When in doubt, run the command with --help to see its supported options.

Related

  • Output Formats guide
  • Configuration reference
  • The vg scan and vg baseline command pages

Related Commands