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

# Quickstart

> Install VectorLint, configure your LLM provider, and run your first review.

Set up VectorLint and run your first content review in under ten minutes. You install VectorLint, add your style instructions, connect an LLM (Large Language Model) provider, and see real output on a file you own.

## Before you begin

VectorLint requires Node.js 18 or later. Node.js 22 LTS is recommended. If you need to install or update Node.js, use [nvm](https://github.com/nvm-sh/nvm) or download directly from [nodejs.org](https://nodejs.org).

You will also need an API key for a supported LLM provider. VectorLint sends your content to the provider you configure for review. Supported providers include: OpenAI, Anthropic, Google Gemini, Azure OpenAI, Amazon Bedrock.

<Warning>
  VectorLint requires a configured LLM provider to produce output. Installing the package alone is not enough. If you skip provider configuration, running `vectorlint` against a file will return no results and no error. Complete Step 2 before running a review.
</Warning>

***

## Step 1: Install VectorLint

Install VectorLint globally from npm:

```bash theme={null}
npm install -g vectorlint
```

Verify the installation:

```bash theme={null}
vectorlint --help
```

You can also run VectorLint without installing it using `npx vectorlint`. See [Installation](/installation) for details on both options.

***

## Step 2: Configure your LLM provider

Open `~/.vectorlint/config.toml` and add your provider and API key. This file is your global provider configuration and applies to all projects on your machine.

For OpenAI:

```toml theme={null}
[env]
LLM_PROVIDER = "openai"
OPENAI_API_KEY = "sk-..."
```

For Anthropic:

```toml theme={null}
[env]
LLM_PROVIDER = "anthropic"
ANTHROPIC_API_KEY = "sk-ant-..."
```

You can also set provider values in a `.env` file in your project root. Project-level values take precedence over `config.toml`. For all supported providers and configuration options, see [Configuring LLM providers](/llm-providers).

***

## Step 3: Create your VECTORLINT.md

After you initialize VectorLint in your repository, the application generates a VECTORLINT.md file in your project root. After you copy your style standards as plain-language instructions into the file, VectorLint builds a "Style Guide Compliance" rule and applies it to your VectorLint reviews.

Run the quick-init command to create the file:

```bash theme={null}
npx vectorlint init --quick
```

Then open `VECTORLINT.md` and add your standards. A few clear instructions are enough to get meaningful output:

```markdown theme={null}
## Voice and tone

- Write in second person. Address the reader as "you."
- Use active voice. Avoid passive constructions.
- Be direct. Remove filler phrases like "it is important to note that."

## Terminology

- Use "sign in" not "log in."
- Use "select" not "click" for UI actions.
- Avoid "easy," "simple," and "just" (these are subjective and dismissive).

## Sentence structure

- Keep sentences under 25 words.
- One idea per sentence.
- Spell out acronyms on first use.
```

You don't need a comprehensive style guide to start. Add rules incrementally as you learn what your rules catch and what they miss.

***

## Step 4: Run a review

Point VectorLint at any Markdown file in your project:

```bash theme={null}
vectorlint path/to/doc.md
```

VectorLint reads your `VECTORLINT.md`, reviews the file against it, and prints findings in your terminal. If the file is clean, VectorLint produces no output and exits with status `0`. If the file has violations, VectorLint prints each finding with its location and a suggested fix.

***

## Next steps

* [Using VECTORLINT.md](/initial-style-check): iterate on your style instructions and understand what makes an effective rule
* [Configuring LLM providers](/llm-providers): full provider reference including Azure OpenAI, Google Gemini, and Amazon Bedrock
* [Configuring a project](/project-config): set up rule packs and file pattern mapping for a full project workflow