> For AI agents: the complete documentation index is available at https://rslint.rs/llms.txt, the full documentation bundle is available at https://rslint.rs/llms-full.txt.

# Getting Started

Rslint is a high-performance, ESLint-compatible linter for JavaScript and TypeScript.

Powered by [TypeScript's native compiler](https://devblogs.microsoft.com/typescript/announcing-typescript-7-0/), it delivers a faster drop-in experience with type-aware rules and optional type checking in the same run.

## Installation


```sh [npm]
npm install @rslint/core -D
```

```sh [yarn]
yarn add @rslint/core -D
```

```sh [pnpm]
pnpm add @rslint/core -D
```

```sh [bun]
bun add @rslint/core -D
```

```sh [deno]
deno add npm:@rslint/core -D
```

## Quick Start

### Initialize Configuration

Run the following command to generate a default configuration file:

```bash
npx rslint --init
```

This creates a `rslint.config.ts` (or `.js` / `.mjs` depending on your project setup) with recommended rules enabled.

### Run the Linter

```bash
# Lint all files
npx rslint .

# Lint with auto-fix
npx rslint --fix .

# Lint with TypeScript type checking (replaces tsc --noEmit)
npx rslint --type-check .
```

### Configuration Preview

The generated config uses the flat config format (an array of config entries), similar to ESLint v10:

```ts
import { defineConfig, js, ts } from '@rslint/core';

export default defineConfig([
  js.configs.recommended,
  ts.configs.recommended,
  {
    rules: {
      '@typescript-eslint/no-unused-vars': 'error',
    },
  },
]);
```

For full configuration options, see the [Configuration](https://rslint.rs/config/index.md) page.

## Editor Integration

Install the [Rstack extension](https://rslint.rs/guide/vscode-extension.md) for Rslint diagnostics, code actions, and auto-fix on save, alongside Rstest and `rs fmt`.