Skip to content

Installation

Install ForgetzLint using the package manager used by your project.

Terminal window
npm install forgetzlint
Terminal window
pnpm add forgetzlint
Terminal window
yarn add forgetzlint
Terminal window
bun add forgetzlint

After installation, verify that ForgetzLint is available in your project.

Run ForgetzLint from your project root:

Terminal window
npx forgetzlint

Or with pnpm:

Terminal window
pnpm exec forgetzlint

If the installation is successful, ForgetzLint will scan your project and report any detected issues.

You only need to install ForgetzLint once for a project. After installation, you can run it through your package manager or add it as a script in your package.json.

{
"scripts": {
"lint": "forgetzlint"
}
}

Then run:

Terminal window
npm run lint

Continue to the Usage guide to learn how to use ForgetzLint.