A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://eslint.org/docs/latest/user-guide/command-line-interface below:

Command Line Interface Reference - ESLint

Command Line Interface Reference Table of Contents

The ESLint Command Line Interface (CLI) lets you execute linting from the terminal. The CLI has a variety of options that you can pass to configure ESLint.

Run the CLI

ESLint requires Node.js for installation. Follow the instructions in the Getting Started Guide to install ESLint.

Most users use npx to run ESLint on the command line like this:

npm
npx eslint [options] [file|dir|glob]* 

1

yarn
yarn dlx eslint [options] [file|dir|glob]* 

1

pnpm
pnpm dlx eslint [options] [file|dir|glob]* 

1

bun
bunx eslint [options] [file|dir|glob]* 

1

Such as:

npm

npx eslint file1.js file2.js 

1
2

yarn

yarn dlx eslint file1.js file2.js 

1
2

pnpm

pnpm dlx eslint file1.js file2.js 

1
2

bun

bunx eslint file1.js file2.js 

1
2

or

yarn

yarn dlx eslint lib/** 

1
2

pnpm

pnpm dlx eslint lib/** 

1
2

Please note that when passing a glob as a parameter, it is expanded by your shell. The results of the expansion can vary depending on your shell, and its configuration. If you want to use node glob syntax, you have to quote your parameter (using double quotes if you need it to run in Windows), as follows:

yarn
yarn dlx eslint "lib/**" 

1

pnpm
pnpm dlx eslint "lib/**" 

1

If you are using a flat configuration file (eslint.config.js), you can also omit the file arguments and ESLint will use .. For instance, these two lines perform the same operation:

If you are not using a flat configuration file, running ESLint without file arguments results in an error.

Note: You can also use alternative package managers such as Yarn or pnpm to run ESLint. For pnpm use pnpm dlx eslint and for Yarn use yarn dlx eslint.

Pass Multiple Values to an Option

Options that accept multiple values can be specified by repeating the option or with a comma-delimited list (other than --ignore-pattern, which does not allow the second style).

Examples of options that accept multiple values:

npm
npx eslint --global describe --global it tests/ 

1

yarn
yarn dlx eslint --global describe --global it tests/ 

1

pnpm
pnpm dlx eslint --global describe --global it tests/ 

1

bun
bunx eslint --global describe --global it tests/ 

1

OR

npm
npx eslint --global describe,it tests/ 

1

yarn
yarn dlx eslint --global describe,it tests/ 

1

pnpm
pnpm dlx eslint --global describe,it tests/ 

1

bun
bunx eslint --global describe,it tests/ 

1

Options

You can view all the CLI options by running npx eslint -h.

eslint [options] file.js [file.js] [dir]

Basic configuration:
  --no-config-lookup              Disable look up for eslint.config.js
  -c, --config path::String       Use this configuration instead of eslint.config.js, eslint.config.mjs, or
                                  eslint.config.cjs
  --inspect-config                Open the config inspector with the current configuration
  --ext [String]                  Specify additional file extensions to lint
  --global [String]               Define global variables
  --parser String                 Specify the parser to be used
  --parser-options Object         Specify parser options

Specify Rules and Plugins:
  --plugin [String]               Specify plugins
  --rule Object                   Specify rules

Fix Problems:
  --fix                           Automatically fix problems
  --fix-dry-run                   Automatically fix problems without saving the changes to the file system
  --fix-type Array                Specify the types of fixes to apply (directive, problem, suggestion, layout)

Ignore Files:
  --no-ignore                     Disable use of ignore files and patterns
  --ignore-pattern [String]       Patterns of files to ignore

Use stdin:
  --stdin                         Lint code provided on <STDIN> - default: false
  --stdin-filename String         Specify filename to process STDIN as

Handle Warnings:
  --quiet                         Report errors only - default: false
  --max-warnings Int              Number of warnings to trigger nonzero exit code - default: -1

Output:
  -o, --output-file path::String  Specify file to write report to
  -f, --format String             Use a specific output format - default: stylish
  --color, --no-color             Force enabling/disabling of color

Inline configuration comments:
  --no-inline-config              Prevent comments from changing config or rules
  --report-unused-disable-directives  Adds reported errors for unused eslint-disable and eslint-enable directives
  --report-unused-disable-directives-severity String  Chooses severity level for reporting unused eslint-disable and
                                                      eslint-enable directives - either: off, warn, error, 0, 1, or 2
  --report-unused-inline-configs String  Adds reported errors for unused eslint inline config comments - either: off, warn, error, 0, 1, or 2

Caching:
  --cache                         Only check changed files - default: false
  --cache-file path::String       Path to the cache file. Deprecated: use --cache-location - default: .eslintcache
  --cache-location path::String   Path to the cache file or directory
  --cache-strategy String         Strategy to use for detecting changed files in the cache - either: metadata or
                                  content - default: metadata

Suppressing Violations:
  --suppress-all                  Suppress all violations - default: false
  --suppress-rule [String]        Suppress specific rules
  --suppressions-location path::String  Specify the location of the suppressions file
  --prune-suppressions            Prune unused suppressions - default: false
  --pass-on-unpruned-suppressions Ignore unused suppressions - default: false

Miscellaneous:
  --init                          Run config initialization wizard - default: false
  --env-info                      Output execution environment information - default: false
  --no-error-on-unmatched-pattern  Prevent errors when pattern is unmatched
  --exit-on-fatal-error           Exit with exit code 2 in case of fatal error - default: false
  --no-warn-ignored               Suppress warnings when the file list includes ignored files
  --pass-on-no-patterns           Exit with exit code 0 in case no file patterns are passed
  --debug                         Output debugging information
  -h, --help                      Show help
  -v, --version                   Output the version number
  --print-config path::String     Print the configuration for the given file
  --stats                         Add statistics to the lint report - default: false
  --flag [String]                 Enable a feature flag
  --mcp                           Start the ESLint MCP server

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

Basic Configuration --no-eslintrc

eslintrc Mode Only. Disables use of configuration from .eslintrc.* and package.json files. For flat config mode, use --no-config-lookup instead.

--no-eslintrc example npm
npx eslint --no-eslintrc file.js 

1

yarn
yarn dlx eslint --no-eslintrc file.js 

1

pnpm
pnpm dlx eslint --no-eslintrc file.js 

1

bun
bunx eslint --no-eslintrc file.js 

1

-c, --config

This option allows you to specify an additional configuration file for ESLint (see Configure ESLint for more).

-c, --config example npm
npx eslint -c ~/my.eslint.config.js file.js 

1

yarn
yarn dlx eslint -c ~/my.eslint.config.js file.js 

1

pnpm
pnpm dlx eslint -c ~/my.eslint.config.js file.js 

1

bun
bunx eslint -c ~/my.eslint.config.js file.js 

1

This example uses the configuration file at ~/my.eslint.config.js, which is used instead of searching for an eslint.config.js file.

--inspect-config

Flat Config Mode Only. This option runs npx @eslint/config-inspector@latest to start the config inspector. You can use the config inspector to better understand what your configuration is doing and which files it applies to. When you use this flag, the CLI does not perform linting.

--inspect-config example npm
npx eslint --inspect-config 

1

yarn
yarn dlx eslint --inspect-config 

1

pnpm
pnpm dlx eslint --inspect-config 

1

bun
bunx eslint --inspect-config 

1

--env

eslintrc Mode Only. This option enables specific environments.

Details about the global variables defined by each environment are available in the Specifying Environments documentation. This option only enables environments. It does not disable environments set in other configuration files. To specify multiple environments, separate them using commas, or use the option multiple times.

--env example npm
npx eslint --env browser,node file.js 

1

yarn
yarn dlx eslint --env browser,node file.js 

1

pnpm
pnpm dlx eslint --env browser,node file.js 

1

bun
bunx eslint --env browser,node file.js 

1

npm
npx eslint --env browser --env node file.js 

1

yarn
yarn dlx eslint --env browser --env node file.js 

1

pnpm
pnpm dlx eslint --env browser --env node file.js 

1

bun
bunx eslint --env browser --env node file.js 

1

--ext

This option allows you to specify additional file extensions to lint.

This option is primarily intended for use in combination with the --no-config-lookup option, since in that case there is no configuration file in which the additional extensions would be specified.

--ext example npm

npx eslint . --ext .ts 

1
2

yarn

yarn dlx eslint . --ext .ts 

1
2

pnpm

pnpm dlx eslint . --ext .ts 

1
2

bun

bunx eslint . --ext .ts 

1
2

npm

npx eslint . --ext .ts --ext .tsx 

1
2

yarn

yarn dlx eslint . --ext .ts --ext .tsx 

1
2

pnpm

pnpm dlx eslint . --ext .ts --ext .tsx 

1
2

bun

bunx eslint . --ext .ts --ext .tsx 

1
2

npm

npx eslint . --ext .ts,.tsx 

1
2

yarn

yarn dlx eslint . --ext .ts,.tsx 

1
2

pnpm

pnpm dlx eslint . --ext .ts,.tsx 

1
2

bun

bunx eslint . --ext .ts,.tsx 

1
2

--global

This option defines global variables so that they are not flagged as undefined by the no-undef rule.

--global example npm
npx eslint --global require,exports:true file.js 

1

yarn
yarn dlx eslint --global require,exports:true file.js 

1

pnpm
pnpm dlx eslint --global require,exports:true file.js 

1

bun
bunx eslint --global require,exports:true file.js 

1

npm
npx eslint --global require --global exports:true 

1

yarn
yarn dlx eslint --global require --global exports:true 

1

pnpm
pnpm dlx eslint --global require --global exports:true 

1

bun
bunx eslint --global require --global exports:true 

1

--parser

This option allows you to specify a parser to be used by ESLint.

--parser example npm

npx eslint --parser @typescript-eslint/parser file.ts 

1
2

yarn

yarn dlx eslint --parser @typescript-eslint/parser file.ts 

1
2

pnpm

pnpm dlx eslint --parser @typescript-eslint/parser file.ts 

1
2

bun

bunx eslint --parser @typescript-eslint/parser file.ts 

1
2

--parser-options

This option allows you to specify parser options to be used by ESLint. The available parser options are determined by the parser being used.

--parser-options example npm

echo '3 ** 4' | npx eslint --stdin --parser-options ecmaVersion:6 

1
2

yarn

echo '3 ** 4' | yarn dlx eslint --stdin --parser-options ecmaVersion:6 

1
2

pnpm

echo '3 ** 4' | pnpm dlx eslint --stdin --parser-options ecmaVersion:6 

1
2

bun

echo '3 ** 4' | bunx eslint --stdin --parser-options ecmaVersion:6 

1
2

npm

echo '3 ** 4' | npx eslint --stdin --parser-options ecmaVersion:7 

1
2

yarn

echo '3 ** 4' | yarn dlx eslint --stdin --parser-options ecmaVersion:7 

1
2

pnpm

echo '3 ** 4' | pnpm dlx eslint --stdin --parser-options ecmaVersion:7 

1
2

bun

echo '3 ** 4' | bunx eslint --stdin --parser-options ecmaVersion:7 

1
2

--resolve-plugins-relative-to

eslintrc Mode Only. Changes the directory where plugins are resolved from.

This option should be used when plugins were installed by someone other than the end user. It should be set to the project directory of the project that has a dependency on the necessary plugins.

For example:

--resolve-plugins-relative-to example npm
npx eslint --config ~/personal-eslintrc.js --resolve-plugins-relative-to /usr/local/lib/ 

1

yarn
yarn dlx eslint --config ~/personal-eslintrc.js --resolve-plugins-relative-to /usr/local/lib/ 

1

pnpm
pnpm dlx eslint --config ~/personal-eslintrc.js --resolve-plugins-relative-to /usr/local/lib/ 

1

bun
bunx eslint --config ~/personal-eslintrc.js --resolve-plugins-relative-to /usr/local/lib/ 

1

Specify Rules and Plugins --plugin

This option specifies a plugin to load.

Before using the plugin, you have to install it using npm.

--plugin example npm
npx eslint --plugin jquery file.js 

1

yarn
yarn dlx eslint --plugin jquery file.js 

1

pnpm
pnpm dlx eslint --plugin jquery file.js 

1

bun
bunx eslint --plugin jquery file.js 

1

npm
npx eslint --plugin eslint-plugin-mocha file.js 

1

yarn
yarn dlx eslint --plugin eslint-plugin-mocha file.js 

1

pnpm
pnpm dlx eslint --plugin eslint-plugin-mocha file.js 

1

bun
bunx eslint --plugin eslint-plugin-mocha file.js 

1

--rule

This option specifies the rules to be used.

These rules are merged with any rules specified with configuration files. If the rule is defined in a plugin, you have to prefix the rule ID with the plugin name and a /.

To ignore rules in .eslintrc configuration files and only run rules specified in the command line, use the --rule flag in combination with the --no-eslintrc flag.

--rule example npm

npx eslint --rule 'quotes: [error, double]' 

1
2

yarn

yarn dlx eslint --rule 'quotes: [error, double]' 

1
2

pnpm

pnpm dlx eslint --rule 'quotes: [error, double]' 

1
2

bun

bunx eslint --rule 'quotes: [error, double]' 

1
2

npm

npx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]' 

1
2

yarn

yarn dlx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]' 

1
2

pnpm

pnpm dlx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]' 

1
2

bun

bunx eslint --rule 'guard-for-in: error' --rule 'brace-style: [error, 1tbs]' 

1
2

npm

npx eslint --rule 'jquery/dollar-sign: error' 

1
2

yarn

yarn dlx eslint --rule 'jquery/dollar-sign: error' 

1
2

pnpm

pnpm dlx eslint --rule 'jquery/dollar-sign: error' 

1
2

bun

bunx eslint --rule 'jquery/dollar-sign: error' 

1
2

npm

npx eslint --rule 'quotes: [error, double]' --no-eslintrc 

1
2

yarn

yarn dlx eslint --rule 'quotes: [error, double]' --no-eslintrc 

1
2

pnpm

pnpm dlx eslint --rule 'quotes: [error, double]' --no-eslintrc 

1
2

bun

bunx eslint --rule 'quotes: [error, double]' --no-eslintrc 

1
2

--rulesdir

Deprecated: Use rules from plugins instead.

eslintrc Mode Only. This option allows you to specify another directory from which to load rules files. This allows you to dynamically load new rules at run time. This is useful when you have custom rules that aren’t suitable for being bundled with ESLint.

Note that, as with core rules and plugin rules, you still need to enable the rules in configuration or via the --rule CLI option in order to actually run those rules during linting. Specifying a rules directory with --rulesdir does not automatically enable the rules within that directory.

--rulesdir example npm
npx eslint --rulesdir my-rules/ file.js 

1

yarn
yarn dlx eslint --rulesdir my-rules/ file.js 

1

pnpm
pnpm dlx eslint --rulesdir my-rules/ file.js 

1

bun
bunx eslint --rulesdir my-rules/ file.js 

1

npm
npx eslint --rulesdir my-rules/ --rulesdir my-other-rules/ file.js 

1

yarn
yarn dlx eslint --rulesdir my-rules/ --rulesdir my-other-rules/ file.js 

1

pnpm
pnpm dlx eslint --rulesdir my-rules/ --rulesdir my-other-rules/ file.js 

1

bun
bunx eslint --rulesdir my-rules/ --rulesdir my-other-rules/ file.js 

1

Fix Problems --fix

This option instructs ESLint to try to fix as many issues as possible. The fixes are made to the actual files themselves and only the remaining unfixed issues are output.

Not all problems are fixable using this option, and the option does not work in these situations:

  1. This option throws an error when code is piped to ESLint.
  2. This option has no effect on code that uses a processor, unless the processor opts into allowing autofixes.

If you want to fix code from stdin or otherwise want to get the fixes without actually writing them to the file, use the --fix-dry-run option.

--fix example npm
npx eslint --fix file.js 

1

yarn
yarn dlx eslint --fix file.js 

1

pnpm
pnpm dlx eslint --fix file.js 

1

bun
bunx eslint --fix file.js 

1

--fix-dry-run

This option has the same effect as --fix with the difference that the fixes are not saved to the file system. Because the default formatter does not output the fixed code, you’ll have to use another formatter (e.g. --format json) to get the fixes.

This makes it possible to fix code from stdin when used with the --stdin flag.

This flag can be useful for integrations (e.g. editor plugins) which need to autofix text from the command line without saving it to the filesystem.

--fix-dry-run example npm
getSomeText | npx eslint --stdin --fix-dry-run --format json 

1

yarn
getSomeText | yarn dlx eslint --stdin --fix-dry-run --format json 

1

pnpm
getSomeText | pnpm dlx eslint --stdin --fix-dry-run --format json 

1

bun
getSomeText | bunx eslint --stdin --fix-dry-run --format json 

1

--fix-type

This option allows you to specify the type of fixes to apply when using either --fix or --fix-dry-run.

This option is helpful if you are using another program to format your code, but you would still like ESLint to apply other types of fixes.

--fix-type example npm
npx eslint --fix --fix-type suggestion . 

1

yarn
yarn dlx eslint --fix --fix-type suggestion . 

1

pnpm
pnpm dlx eslint --fix --fix-type suggestion . 

1

bun
bunx eslint --fix --fix-type suggestion . 

1

npm
npx eslint --fix --fix-type suggestion --fix-type problem . 

1

yarn
yarn dlx eslint --fix --fix-type suggestion --fix-type problem . 

1

pnpm
pnpm dlx eslint --fix --fix-type suggestion --fix-type problem . 

1

bun
bunx eslint --fix --fix-type suggestion --fix-type problem . 

1

npm
npx eslint --fix --fix-type suggestion,layout . 

1

yarn
yarn dlx eslint --fix --fix-type suggestion,layout . 

1

pnpm
pnpm dlx eslint --fix --fix-type suggestion,layout . 

1

bun
bunx eslint --fix --fix-type suggestion,layout . 

1

Ignore Files --ignore-path

eslintrc Mode Only. This option allows you to specify the file to use as your .eslintignore.

Note: --ignore-path is only supported when using deprecated configuration. If you want to include patterns from a .gitignore file in your eslint.config.js file, please see including .gitignore files.

--ignore-path example npm
npx eslint --ignore-path tmp/.eslintignore file.js 

1

yarn
yarn dlx eslint --ignore-path tmp/.eslintignore file.js 

1

pnpm
pnpm dlx eslint --ignore-path tmp/.eslintignore file.js 

1

bun
bunx eslint --ignore-path tmp/.eslintignore file.js 

1

npm
npx eslint --ignore-path .gitignore file.js 

1

yarn
yarn dlx eslint --ignore-path .gitignore file.js 

1

pnpm
pnpm dlx eslint --ignore-path .gitignore file.js 

1

bun
bunx eslint --ignore-path .gitignore file.js 

1

--no-ignore

Disables excluding of files from .eslintignore files, --ignore-path flags, --ignore-pattern flags, and the ignorePatterns property in config files.

--no-ignore example npm
npx eslint --no-ignore file.js 

1

yarn
yarn dlx eslint --no-ignore file.js 

1

pnpm
pnpm dlx eslint --no-ignore file.js 

1

bun
bunx eslint --no-ignore file.js 

1

--ignore-pattern

This option allows you to specify patterns of files to ignore. In eslintrc mode, these are in addition to .eslintignore.

--ignore-pattern example npm
npx eslint --ignore-pattern "/lib/" --ignore-pattern "/src/vendor/*" . 

1

yarn
yarn dlx eslint --ignore-pattern "/lib/" --ignore-pattern "/src/vendor/*" . 

1

pnpm
pnpm dlx eslint --ignore-pattern "/lib/" --ignore-pattern "/src/vendor/*" . 

1

bun
bunx eslint --ignore-pattern "/lib/" --ignore-pattern "/src/vendor/*" . 

1

Use stdin --stdin

This option tells ESLint to read and lint source code from STDIN instead of from files. You can use this to pipe code to ESLint.

--stdin example npm
cat myFile.js | npx eslint --stdin 

1

yarn
cat myFile.js | yarn dlx eslint --stdin 

1

pnpm
cat myFile.js | pnpm dlx eslint --stdin 

1

bun
cat myFile.js | bunx eslint --stdin 

1

--stdin-filename

This option allows you to specify a filename to process STDIN as.

This is useful when processing files from STDIN and you have rules which depend on the filename.

--stdin-filename example npm
cat myFile.js | npx eslint --stdin --stdin-filename myfile.js 

1

yarn
cat myFile.js | yarn dlx eslint --stdin --stdin-filename myfile.js 

1

pnpm
cat myFile.js | pnpm dlx eslint --stdin --stdin-filename myfile.js 

1

bun
cat myFile.js | bunx eslint --stdin --stdin-filename myfile.js 

1

Handle Warnings --quiet

This option allows you to disable reporting on warnings and running of rules set to warn. If you enable this option, only errors are reported by ESLint and only rules set to error will be run.

--quiet example npm
npx eslint --quiet file.js 

1

yarn
yarn dlx eslint --quiet file.js 

1

pnpm
pnpm dlx eslint --quiet file.js 

1

bun
bunx eslint --quiet file.js 

1

--max-warnings

This option allows you to specify a warning threshold, which can be used to force ESLint to exit with an error status if there are too many warning-level rule violations in your project.

Normally, if ESLint runs and finds no errors (only warnings), it exits with a success exit status. However, if --max-warnings is specified and the total warning count is greater than the specified threshold, ESLint exits with an error status.

Important

When used alongside --quiet, this will cause rules marked as warn to still be run, but not reported.

--max-warnings example npm
npx eslint --max-warnings 10 file.js 

1

yarn
yarn dlx eslint --max-warnings 10 file.js 

1

pnpm
pnpm dlx eslint --max-warnings 10 file.js 

1

bun
bunx eslint --max-warnings 10 file.js 

1

Output -o, --output-file

Write the output of linting results to a specified file.

-o, --output-file example npm
npx eslint -o ./test/test.html 

1

yarn
yarn dlx eslint -o ./test/test.html 

1

pnpm
pnpm dlx eslint -o ./test/test.html 

1

bun
bunx eslint -o ./test/test.html 

1

-f, --format

This option specifies the output format for the console.

If you are using a custom formatter defined in a local file, you can specify the path to the custom formatter file.

An npm-installed formatter is resolved with or without eslint-formatter- prefix.

When specified, the given format is output to the console. If you’d like to save that output into a file, you can do so on the command line like so:

npm

npx eslint -f json file.js > results.json 

1
2

yarn

yarn dlx eslint -f json file.js > results.json 

1
2

pnpm

pnpm dlx eslint -f json file.js > results.json 

1
2

bun

bunx eslint -f json file.js > results.json 

1
2

-f, --format example

Use the built-in json formatter:

npm
npx eslint --format json file.js 

1

yarn
yarn dlx eslint --format json file.js 

1

pnpm
pnpm dlx eslint --format json file.js 

1

bun
bunx eslint --format json file.js 

1

Use a local custom formatter:

npm
npx eslint -f ./customformat.js file.js 

1

yarn
yarn dlx eslint -f ./customformat.js file.js 

1

pnpm
pnpm dlx eslint -f ./customformat.js file.js 

1

bun
bunx eslint -f ./customformat.js file.js 

1

Use an npm-installed formatter:

npm
npm install eslint-formatter-pretty

1

yarn
yarn add eslint-formatter-pretty

1

pnpm
pnpm add eslint-formatter-pretty

1

bun
bun add eslint-formatter-pretty

1

Then run one of the following commands

npm
npx eslint -f pretty file.js 

1

yarn
yarn dlx eslint -f pretty file.js 

1

pnpm
pnpm dlx eslint -f pretty file.js 

1

bun
bunx eslint -f pretty file.js 

1

or alternatively

npm
npx eslint -f eslint-formatter-pretty file.js 

1

yarn
yarn dlx eslint -f eslint-formatter-pretty file.js 

1

pnpm
pnpm dlx eslint -f eslint-formatter-pretty file.js 

1

bun
bunx eslint -f eslint-formatter-pretty file.js 

1

--color and --no-color

These options force the enabling/disabling of colorized output.

You can use these options to override the default behavior, which is to enable colorized output unless no TTY is detected, such as when piping eslint through cat or less.

--color and --no-color example npm
npx eslint --color file.js | cat 

1

yarn
yarn dlx eslint --color file.js | cat 

1

pnpm
pnpm dlx eslint --color file.js | cat 

1

bun
bunx eslint --color file.js | cat 

1

npm
npx eslint --no-color file.js 

1

yarn
yarn dlx eslint --no-color file.js 

1

pnpm
pnpm dlx eslint --no-color file.js 

1

bun
bunx eslint --no-color file.js 

1

--no-inline-config

This option prevents inline comments like /*eslint-disable*/ or /*global foo*/ from having any effect.

This allows you to set an ESLint config without files modifying it. All inline config comments are ignored, such as:

--no-inline-config example npm
npx eslint --no-inline-config file.js 

1

yarn
yarn dlx eslint --no-inline-config file.js 

1

pnpm
pnpm dlx eslint --no-inline-config file.js 

1

bun
bunx eslint --no-inline-config file.js 

1

--report-unused-disable-directives

This option causes ESLint to report directive comments like // eslint-disable-line when no errors would have been reported on that line anyway.

This can be useful to prevent future errors from unexpectedly being suppressed, by cleaning up old eslint-disable and eslint-enable comments which are no longer applicable.

Warning

When using this option, it is possible that new errors start being reported whenever ESLint or custom rules are upgraded.

For example, suppose a rule has a bug that causes it to report a false positive, and an eslint-disable comment is added to suppress the incorrect report. If the bug is then fixed in a patch release of ESLint, the eslint-disable comment becomes unused since ESLint is no longer generating an incorrect report. This results in a new reported error for the unused directive if the --report-unused-disable-directives option is used.

--report-unused-disable-directives example npm
npx eslint --report-unused-disable-directives file.js 

1

yarn
yarn dlx eslint --report-unused-disable-directives file.js 

1

pnpm
pnpm dlx eslint --report-unused-disable-directives file.js 

1

bun
bunx eslint --report-unused-disable-directives file.js 

1

--report-unused-disable-directives-severity

Same as --report-unused-disable-directives, but allows you to specify the severity level (error, warn, off) of the reported errors. Only one of these two options can be used at a time.

--report-unused-disable-directives-severity example npm
npx eslint --report-unused-disable-directives-severity warn file.js 

1

yarn
yarn dlx eslint --report-unused-disable-directives-severity warn file.js 

1

pnpm
pnpm dlx eslint --report-unused-disable-directives-severity warn file.js 

1

bun
bunx eslint --report-unused-disable-directives-severity warn file.js 

1

--report-unused-inline-configs

This option causes ESLint to report inline config comments like /* eslint rule-name: "error" */ whose rule severity and any options match what’s already been configured.

This can be useful to keep files clean and devoid of misleading clutter. Inline config comments are meant to change ESLint’s behavior in some way: if they change nothing, there is no reason to leave them in.

--report-unused-inline-configs example
npx eslint --report-unused-inline-configs error file.js

1

Caching --cache

Store the info about processed files in order to only operate on the changed ones. Enabling this option can dramatically improve ESLint’s run time performance by ensuring that only changed files are linted. The cache is stored in .eslintcache by default.

If you run ESLint with --cache and then run ESLint without --cache, the .eslintcache file will be deleted. This is necessary because the results of the lint might change and make .eslintcache invalid. If you want to control when the cache file is deleted, then use --cache-location to specify an alternate location for the cache file.

Autofixed files are not placed in the cache. Subsequent linting that does not trigger an autofix will place it in the cache.

--cache example npm
npx eslint --cache file.js 

1

yarn
yarn dlx eslint --cache file.js 

1

pnpm
pnpm dlx eslint --cache file.js 

1

bun
bunx eslint --cache file.js 

1

--cache-file

Deprecated: Use --cache-location instead.

Path to the cache file. If none specified .eslintcache is used. The file is created in the directory where the eslint command is executed.

--cache-location

Specify the path to the cache location. Can be a file or a directory.

If the directory for the cache does not exist make sure you add a trailing / on *nix systems or \ on Windows. Otherwise, the path is assumed to be a file.

--cache-location example npm
npx eslint "src/**/*.js" --cache --cache-location "/Users/user/.eslintcache/" 

1

yarn
yarn dlx eslint "src/**/*.js" --cache --cache-location "/Users/user/.eslintcache/" 

1

pnpm
pnpm dlx eslint "src/**/*.js" --cache --cache-location "/Users/user/.eslintcache/" 

1

bun
bunx eslint "src/**/*.js" --cache --cache-location "/Users/user/.eslintcache/" 

1

--cache-strategy

Strategy for the cache to use for detecting changed files.

The content strategy can be useful in cases where the modification time of your files changes even if their contents have not. For example, this can happen during git operations like git clone because git does not track file modification time.

--cache-strategy example npm
npx eslint "src/**/*.js" --cache --cache-strategy content 

1

yarn
yarn dlx eslint "src/**/*.js" --cache --cache-strategy content 

1

pnpm
pnpm dlx eslint "src/**/*.js" --cache --cache-strategy content 

1

bun
bunx eslint "src/**/*.js" --cache --cache-strategy content 

1

Suppressing Violations --suppress-all

Suppresses existing violations, so that they are not being reported in subsequent runs. It allows you to enable one or more lint rules and be notified only when new violations show up. The suppressions are stored in eslint-suppressions.json by default, unless otherwise specified by --suppressions-location. The file gets updated with the new suppressions.

--suppress-all example npm
npx eslint "src/**/*.js" --suppress-all 

1

yarn
yarn dlx eslint "src/**/*.js" --suppress-all 

1

pnpm
pnpm dlx eslint "src/**/*.js" --suppress-all 

1

bun
bunx eslint "src/**/*.js" --suppress-all 

1

--suppress-rule

Suppresses violations for specific rules, so that they are not being reported in subsequent runs. Similar to --suppress-all, the suppressions are stored in eslint-suppressions.json by default, unless otherwise specified by --suppressions-location. The file gets updated with the new suppressions.

--suppress-rule example npm
npx eslint "src/**/*.js" --suppress-rule no-console --suppress-rule indent 

1

yarn
yarn dlx eslint "src/**/*.js" --suppress-rule no-console --suppress-rule indent 

1

pnpm
pnpm dlx eslint "src/**/*.js" --suppress-rule no-console --suppress-rule indent 

1

bun
bunx eslint "src/**/*.js" --suppress-rule no-console --suppress-rule indent 

1

--suppressions-location

Specify the path to the suppressions location. Can be a file or a directory.

--suppressions-location example npm
npx eslint "src/**/*.js" --suppressions-location ".eslint-suppressions-example.json" 

1

yarn
yarn dlx eslint "src/**/*.js" --suppressions-location ".eslint-suppressions-example.json" 

1

pnpm
pnpm dlx eslint "src/**/*.js" --suppressions-location ".eslint-suppressions-example.json" 

1

bun
bunx eslint "src/**/*.js" --suppressions-location ".eslint-suppressions-example.json" 

1

--prune-suppressions

Prune unused suppressions from the suppressions file. This option is useful when you addressed one or more of the suppressed violations.

--prune-suppressions example npm
npx eslint "src/**/*.js" --prune-suppressions 

1

yarn
yarn dlx eslint "src/**/*.js" --prune-suppressions 

1

pnpm
pnpm dlx eslint "src/**/*.js" --prune-suppressions 

1

bun
bunx eslint "src/**/*.js" --prune-suppressions 

1

--pass-on-unpruned-suppressions

Ignore unused suppressions. By default, ESLint exits with exit code 2 and displays an error message if there are unused suppressions in the suppressions file. When you use this flag, unused suppressions do not affect the exit code and ESLint doesn’t output an error about unused suppressions.

--pass-on-unpruned-suppressions example npm
npx eslint "src/**/*.js" --pass-on-unpruned-suppressions 

1

yarn
yarn dlx eslint "src/**/*.js" --pass-on-unpruned-suppressions 

1

pnpm
pnpm dlx eslint "src/**/*.js" --pass-on-unpruned-suppressions 

1

bun
bunx eslint "src/**/*.js" --pass-on-unpruned-suppressions 

1

Miscellaneous --init

This option runs npm init @eslint/config to start the config initialization wizard. It’s designed to help new users quickly create an eslint.config.js file by answering a few questions. When you use this flag, the CLI does not perform linting.

The resulting configuration file is created in the current directory.

--init example --env-info

This option outputs information about the execution environment, including the version of Node.js, npm, and local and global installations of ESLint.

The ESLint team may ask for this information to help solve bugs. When you use this flag, the CLI does not perform linting.

--env-info example yarn
yarn dlx eslint --env-info 

1

pnpm
pnpm dlx eslint --env-info 

1

--no-error-on-unmatched-pattern

This option prevents errors when a quoted glob pattern or --ext is unmatched. This does not prevent errors when your shell can’t match a glob.

--no-error-on-unmatched-pattern example npm
npx eslint --no-error-on-unmatched-pattern --ext .ts "lib/*" 

1

yarn
yarn dlx eslint --no-error-on-unmatched-pattern --ext .ts "lib/*" 

1

pnpm
pnpm dlx eslint --no-error-on-unmatched-pattern --ext .ts "lib/*" 

1

bun
bunx eslint --no-error-on-unmatched-pattern --ext .ts "lib/*" 

1

--exit-on-fatal-error

This option causes ESLint to exit with exit code 2 if one or more fatal parsing errors occur. Without this option, ESLint reports fatal parsing errors as rule violations.

--exit-on-fatal-error example npm
npx eslint --exit-on-fatal-error file.js 

1

yarn
yarn dlx eslint --exit-on-fatal-error file.js 

1

pnpm
pnpm dlx eslint --exit-on-fatal-error file.js 

1

bun
bunx eslint --exit-on-fatal-error file.js 

1

--no-warn-ignored

Flat Config Mode Only. This option suppresses both File ignored by default and File ignored because of a matching ignore pattern warnings when an ignored filename is passed explicitly. It is useful when paired with --max-warnings 0 as it will prevent exit code 1 due to the aforementioned warning.

--no-warn-ignored example npm
npx eslint --no-warn-ignored --max-warnings 0 ignored-file.js 

1

yarn
yarn dlx eslint --no-warn-ignored --max-warnings 0 ignored-file.js 

1

pnpm
pnpm dlx eslint --no-warn-ignored --max-warnings 0 ignored-file.js 

1

bun
bunx eslint --no-warn-ignored --max-warnings 0 ignored-file.js 

1

--pass-on-no-patterns

This option allows ESLint to exit with code 0 when no file or directory patterns are passed. Without this option, ESLint assumes you want to use . as the pattern. (When running in legacy eslintrc mode, ESLint will exit with code 1.)

--pass-on-no-patterns example npm
npx eslint --pass-on-no-patterns 

1

yarn
yarn dlx eslint --pass-on-no-patterns 

1

pnpm
pnpm dlx eslint --pass-on-no-patterns 

1

bun
bunx eslint --pass-on-no-patterns 

1

--debug

This option outputs debugging information to the console. Add this flag to an ESLint command line invocation in order to get extra debugging information while the command runs.

This information is useful when you’re seeing a problem and having a hard time pinpointing it. The ESLint team may ask for this debugging information to help solve bugs.

--debug example npm
npx eslint --debug test.js 

1

yarn
yarn dlx eslint --debug test.js 

1

pnpm
pnpm dlx eslint --debug test.js 

1

bun
bunx eslint --debug test.js 

1

-h, --help

This option outputs the help menu, displaying all of the available options. All other options are ignored when this is present. When you use this flag, the CLI does not perform linting.

-h, --help example -v, --version

This option outputs the current ESLint version onto the console. All other options are ignored when this is present. When you use this flag, the CLI does not perform linting.

-v, --version example yarn
yarn dlx eslint --version 

1

pnpm
pnpm dlx eslint --version 

1

--print-config

This option outputs the configuration to be used for the file passed. When present, no linting is performed and only config-related options are valid. When you use this flag, the CLI does not perform linting.

--print-config example npm
npx eslint --print-config file.js 

1

yarn
yarn dlx eslint --print-config file.js 

1

pnpm
pnpm dlx eslint --print-config file.js 

1

bun
bunx eslint --print-config file.js 

1

--stats

This option adds a series of detailed performance statistics (see Stats type) such as the parse-, fix- and lint-times (time per rule) to result objects that are passed to the formatter (see Stats CLI usage).

This option is intended for use with custom formatters that display statistics. It can also be used with the built-in json formatter.

--stats example npm
npx eslint --stats --format json file.js 

1

yarn
yarn dlx eslint --stats --format json file.js 

1

pnpm
pnpm dlx eslint --stats --format json file.js 

1

bun
bunx eslint --stats --format json file.js 

1

--flag

This option enables one or more feature flags for ESLint.

--flag example npm
npx eslint --flag x_feature file.js 

1

yarn
yarn dlx eslint --flag x_feature file.js 

1

pnpm
pnpm dlx eslint --flag x_feature file.js 

1

bun
bunx eslint --flag x_feature file.js 

1

--mcp

This option starts the ESLint MCP server for use with AI agents.

--mcp example Exit Codes

When linting files, ESLint exits with one of the following exit codes:


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4