---
source: tasks/website/src/linter/cli.rs
expression: snapshot
---
Usage: [-c=<./oxlintrc.json>] [--fix] [--fix-suggestions] [--fix-dangerously] [PATH]...

Basic Configuration
    -c, --config=<./oxlintrc.json>  Oxlint configuration file (experimental)
                              * only `.json` extension is supported
                              * tries to be compatible with the ESLint v8's format
        --tsconfig=<./tsconfig.json>  TypeScript `tsconfig.json` path for reading path alias and
                              project references for import plugin

Allowing / Denying Multiple Lints
   Accumulate rules and categories from left to right on the command-line.
   For example `-D correctness -A no-debugger` or `-A all -D no-debugger`.
   The categories are:
   * `correctness` - code that is outright wrong or useless (default)
   * `suspicious`  - code that is most likely wrong or useless
   * `pedantic`    - lints which are rather strict or have occasional false positives
   * `style`       - code that should be written in a more idiomatic way
   * `nursery`     - new lints that are still under development
   * `restriction` - lints which prevent the use of language and library features
   * `all`         - all the categories listed above except nursery
    -A, --allow=NAME          Allow the rule or category (suppress the lint)
    -W, --warn=NAME           Deny the rule or category (emit a warning)
    -D, --deny=NAME           Deny the rule or category (emit an error)

Enable Plugins
        --disable-react-plugin  Disable react plugin, which is turned on by default
        --disable-unicorn-plugin  Disable unicorn plugin, which is turned on by default
        --disable-oxc-plugin  Disable oxc unique rules, which is turned on by default
        --disable-typescript-plugin  Disable TypeScript plugin, which is turned on by default
        --import-plugin       Enable the experimental import plugin and detect ESM problems. It is
                              recommended to use along side with the `--tsconfig` option.
        --jsdoc-plugin        Enable the experimental jsdoc plugin and detect JSDoc problems
        --jest-plugin         Enable the Jest plugin and detect test problems
        --vitest-plugin       Enable the Vitest plugin and detect test problems
        --jsx-a11y-plugin     Enable the JSX-a11y plugin and detect accessibility problems
        --nextjs-plugin       Enable the Next.js plugin and detect Next.js problems
        --react-perf-plugin   Enable the React performance plugin and detect rendering performance
                              problems
        --promise-plugin      Enable the promise plugin and detect promise usage problems

Fix Problems
        --fix                 Fix as many issues as possible. Only unfixed issues are reported in
                              the output
        --fix-suggestions     Apply auto-fixable suggestions. May change program behavior.
        --fix-dangerously     Apply dangerous fixes and suggestions.

Ignore Files
        --ignore-path=PATH    Specify the file to use as your .eslintignore
        --ignore-pattern=PAT  Specify patterns of files to ignore (in addition to those in
                              .eslintignore)
        --no-ignore           Disables excluding of files from .eslintignore files, --ignore-path
                              flags and --ignore-pattern flags
        --symlinks            Follow symbolic links. Oxlint ignores symbolic links by default.

Handle Warnings
        --quiet               Disable reporting on warnings, only errors are reported
        --deny-warnings       Ensure warnings produce a non-zero exit code
        --max-warnings=INT    Specify a warning threshold, which can be used to force exit with an
                              error status if there are too many warning-level rule violations in
                              your project

Output
    -f, --format=ARG          Use a specific output format (default, json, unix, checkstyle, github)

Miscellaneous
        --silent              Do not display any diagnostics
        --threads=INT         Number of threads to use. Set to 1 for using only 1 CPU core

Available positional items:
    PATH                      Single file, single path or list of paths

Available options:
        --rules               list all the rules that are currently registered
    -h, --help                Prints help information
    -V, --version             Prints version information
