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

# Installation

> Add the Gadget ESLint plugin to your project.

## Requirements

| Dependency    | Version                                                 |
| ------------- | ------------------------------------------------------- |
| Node.js       | `>= 18.18`                                              |
| ESLint        | `>= 9`                                                  |
| Config format | Flat config (`eslint.config.js` or `eslint.config.mjs`) |

<Warning>
  Legacy `.eslintrc` files are not supported. The plugin uses the ESLint flat config format exclusively.
</Warning>

## Install

```bash theme={null}
yarn add -D @aurelienbbn/eslint-plugin-gadget eslint
```

## Verify the install

The plugin default export contains everything you need:

```js theme={null}
import gadget from "@aurelienbbn/eslint-plugin-gadget";

// gadget.configs.recommended  - warns on most rules, errors on critical ones
// gadget.configs.strict       - errors on every rule
// gadget.rules                - all 16 rules
// gadget.meta.name            - "@aurelienbbn/eslint-plugin-gadget"
// gadget.meta.version         - current version
```

## Next step

<Card title="Quick start" icon="bolt" href="/eslint-plugin/getting-started/configuration">
  Pick a preset and start linting.
</Card>