Quickstart

This page shows the recommended setup for Oxlint and the most common workflows, with copy-paste commands.

Install

Install oxlint as a dev dependency:

npm

$ npm add -D oxlint
``````sh [pnpm]
$ pnpm add -D oxlint
``````sh [yarn]
$ yarn add -D oxlint
``````sh [bun]
$ bun add -D oxlint
``````json [package.json]
{
  "scripts": {
    "lint": "oxlint",
    "lint:fix": "oxlint --fix"
  }
}
``````sh [npm]
npm run lint
``````sh [pnpm]
pnpm run lint
``````sh [yarn]
yarn run lint
``````sh [bun]
bun run lint
``````sh [npm]
npm run lint:fix
``````sh [pnpm]
pnpm run lint:fix
``````sh [yarn]
yarn run lint:fix
``````sh [bun]
bun run lint:fix
``````sh
oxlint [OPTIONS] [PATH]...
``````json [npm]
{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "npm run lint"
  }
}
``````json [pnpm]
{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "pnpm run lint"
  }
}
``````json [yarn]
{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "yarn run lint"
  }
}
``````json [bun]
{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "bun run lint"
  }
}
``````sh
oxlint --init
``````sh
oxlint
``````sh
oxlint --fix
``````sh
oxlint --fix-suggestions
``````sh
oxlint --fix-dangerously
``````sh
oxlint --ignore-path .oxlintignore
``````sh
oxlint --ignore-pattern "dist/**" --ignore-pattern "*.min.js"
``````sh
oxlint --no-ignore
``````sh
oxlint --quiet
``````sh
oxlint --deny-warnings
``````sh
oxlint --max-warnings 0
``````sh
oxlint -f json
``````sh
oxlint --print-config path/to/file.ts
``````sh
oxlint --rules