> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vectorlint.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Understand VectorLint's configuration files and how they work together.

VectorLint is configured through four files. Running `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                                                |

For more information about integrating your style guide into the `VECTORLINT.md` file, see [Your first review](./initial-style-check).
For more information about rule pack files, see [Defining your style rules](./style-guide).

***

## 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:

```bash theme={null}
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 reviews your content against it.

Run a review:

```bash theme={null}
vectorlint doc.md
```

### Full configuration

For a comprehensive setup with custom rule packs and file-specific targets:

```bash theme={null}
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](/llm-providers): configure your LLM provider, search provider, and false-positive filtering threshold
* [Project Configuration](/project-config): choose which rules apply to which files and understand cascading behavior
* [Defining your style rules](/style-guide): create `VECTORLINT.md` and write targeted rule pack files

***

## Run a review

Once your provider is configured, run a review against any Markdown file:

```bash theme={null}
vectorlint doc.md
```

VectorLint ships with a built-in preset containing eight `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

<CardGroup cols={2}>
  <Card title="LLM Providers" icon="key" href="/llm-providers">
    Configure the model and API keys that power your reviews.
  </Card>

  <Card title="Project Configuration" icon="sliders" href="/project-config">
    Choose which rules apply to which files and configure review behavior.
  </Card>

  <Card title="Defining your style rules" icon="file-pen" href="/style-guide">
    Create VECTORLINT.md and write custom rule pack files.
  </Card>

  <Card title="CLI reference" icon="terminal" href="/cli-reference">
    Full reference for commands, flags, and exit codes.
  </Card>

  <Card title="Environment variables" icon="code" href="/env-variables">
    Complete reference for all runtime configuration variables.
  </Card>
</CardGroup>