Getting Started

Install ViberTest and run your first scan in under a minute. No config files, no plugins, no setup.

Prerequisites#

Install ViberTest globally with your preferred package manager:

npmbash

$ npm i -g vibertest

Navigate to any JS/TS project and run:

Terminalbash

$ vibertest scan .

ViberTest will analyze all .js, .ts, .jsx, and .tsx files, run all 24 rules, and output a health score with a letter grade.

Flag	Description
-r, --rules <rules>	Comma-separated list of rule IDs to run
-f, --format <format>	Output format: "terminal" (default) or "json"
-o, --output <path>	Output file path for JSON reports
-s, --silent	Suppress terminal output (useful with --format json)

See the full CLI Reference for scan for all options and examples.

Scan a specific directorybash

$ vibertest scan ./src

Export results as JSONbash

$ vibertest scan . --format json --output report.json

Run only specific rulesbash

$ vibertest scan . --rules oversized-files,dead-code,ai-smell

Silent mode (no terminal output, writes JSON to file)bash

$ vibertest scan . --format json --silent --output report.json

ViberTest works with zero config. If you want to customize thresholds or disable rules:

Terminalbash

$ vibertest init
# Creates .vibertestrc.json with default settings

See the Configuration guide for all options.

Code	Meaning
0	Scan completed, no issues found
1	Scan completed, issues found
2	Scan failed (error)