Skip to main content
VectorLint is configured through four files. Running vectorlint init creates the first two automatically.
FileLocationPurposeRequired
VECTORLINT.mdProject rootGlobal style instructions in plain language — prepended to every evaluationRequired for zero-config mode
.vectorlint.iniProject rootFile patterns, rule packs, strictness overridesRequired for rule packs and file-specific configuration
config.toml~/.vectorlint/LLM provider API keys — applies globally across projectsAlways required
Rule pack filesRulesPath directoryTargeted LLM prompts for specific checks — for advanced content quality workflowsOptional
For more information about integrating your style guide into the VECTORLINT.md file, see Your first style check. 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 check content against a style guide with no additional setup: 
vectorlint init --quick
This creates a VECTORLINT.md file in your project root where you paste your style guide. VectorLint automatically creates a “Style Guide Compliance” rule from it and evaluates your content against it. Run a check: 
vectorlint doc.md

​
Full configuration

For a comprehensive setup with custom rule packs and file-specific targets: 
vectorlint init
This creates both .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 — map file patterns to rule packs, set strictness overrides, and understand cascading behavior
  • Defining your style rules — create VECTORLINT.md and write targeted rule pack files

​
Run a check

Once your provider is configured, run a check against any Markdown file: 
vectorlint doc.md
VectorLint ships with a built-in preset containing rules for AI pattern detection and directness. 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 evaluations.

Project Configuration

Map files to rule packs and tune evaluation 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.