Skip to main content
Vibrant supports multiple command-line options to customize analysis behavior.

​
Analysis options

​
--format
string
Output format for analysis results.Values: pretty, compact, plan, jsonDefault: pretty
vibrant . --format compact
vibrant . --format json
See Output Formats for examples of each format.
​
--ignore
string
Comma-separated patterns to ignore during analysis.Default: "" (empty)
vibrant . --ignore "test/**,*.spec.ts"
vibrant . --ignore "node_modules,dist,build"
Patterns are combined with ignore patterns from vibrant.config.js.
​
--fix
boolean
Automatically fix problems where possible.Default: false
vibrant . --fix
Only applies fixes for rules that support auto-fixing. After fixing, Vibrant displays the number of issues fixed.

​
AI options

​
--ai
boolean
Enable AI-powered analysis for deeper code inspection.Default: false
vibrant . --ai
vibrant . --ai --provider openrouter
Requires an AI provider to be configured via environment variables or the --provider flag.
​
--provider
string
AI provider to use for analysis.Values: openai, claude, gemini, ollama, openrouterDefault: Auto-detected from environment variables
vibrant . --ai --provider openrouter
vibrant . --ai --provider ollama
Each provider requires specific environment variables:
  • openrouter: OPENROUTER_API_KEY
  • openai: OPENAI_API_KEY
  • gemini: GOOGLE_GENERATIVE_AI_API_KEY
  • claude: ANTHROPIC_API_KEY
  • ollama: No API key required (runs locally)
​
--no-cache
boolean
Disable analysis cache for AI-powered analysis.Default: false (cache enabled)
vibrant . --ai --no-cache
By default, Vibrant caches AI analysis results to improve performance on subsequent runs. Use this flag to force fresh analysis.

​
Global options

​
--version
flag
Display version number.
vibrant --version
vibrant -V
​
--help
flag
Display help for command.
vibrant --help
vibrant -h

​
Environment variables

Vibrant automatically loads environment variables from .env files in the following order:
  1. .env
  2. .env.local
  3. .env.development
  4. .env.production
The first file found is loaded. This is useful for configuring AI providers without passing API keys via command line.

​
AI provider keys

.env
OPENROUTER_API_KEY=sk-or-v1-...
OPENAI_API_KEY=sk-...
GOOGLE_GENERATIVE_AI_API_KEY=...
ANTHROPIC_API_KEY=sk-ant-...

​
Option precedence

When the same option is specified in multiple places, Vibrant uses this precedence (highest to lowest):
  1. Command-line flags
  2. Configuration file (vibrant.config.js)
  3. Default values

​
Example

vibrant.config.js
module.exports = {
  format: 'compact',
  ignore: ['node_modules', 'dist']
};

# Uses format 'json' (CLI overrides config)
vibrant . --format json

# Uses format 'compact' (from config)
vibrant .

# Combines ignore patterns from both CLI and config
vibrant . --ignore "test/**"
# Result: ['node_modules', 'dist', 'test/**']

Build docs developers (and LLMs) love

Get started for freeTalk to us