vectorlint init creates the first two automatically.
| File | Location | Purpose | Required |
|---|---|---|---|
VECTORLINT.md | Project root | Global style instructions in plain language, applied to every review | Required for zero-config mode |
.vectorlint.ini | Project root | File patterns and rule packs | Required for rule packs and file-specific configuration |
config.toml | ~/.vectorlint/ | LLM provider API keys (applies globally across projects) | Always required |
| Rule pack files | RulesPath directory | Targeted rules for specific standards, for advanced content quality workflows | Optional |
VECTORLINT.md file, see Your first review.
For more information about rule pack files, see Defining your style rules.
Initialize your project
VectorLint provides two initialization modes depending on how much configuration you need.Zero-config mode (fastest)
If you want to review content against a style guide with no additional setup:VECTORLINT.md file in your project root where you paste your style guide. VectorLint automatically creates a “Style Guide Compliance” rule from it and reviews your content against it.
Run a review:
Full configuration
For a comprehensive setup with custom rule packs and file-specific targets:.vectorlint.ini and ~/.vectorlint/config.toml. Edit them manually or follow the guides below.
Configuration guides
Each file has its own reference page with complete field definitions, examples, and behavior details.- LLM Providers: configure your LLM provider, search provider, and false-positive filtering threshold
- Project Configuration: choose which rules apply to which files and understand cascading behavior
- Defining your style rules: create
VECTORLINT.mdand write targeted rule pack files
Run a review
Once your provider is configured, run a review against any Markdown file:check rules (AI Pattern, Capitalization, Consistency, Inclusivity, Passive Voice, Repetition, Unsupported Claims, Wordiness). The init command configures this automatically so you get useful output immediately.
Next steps
LLM Providers
Configure the model and API keys that power your reviews.
Project Configuration
Choose which rules apply to which files and configure review behavior.
Defining your style rules
Create VECTORLINT.md and write custom rule pack files.
CLI reference
Full reference for commands, flags, and exit codes.
Environment variables
Complete reference for all runtime configuration variables.