Command Line Interface Reference

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 requiresNode.js for installation. Follow the instructions in theGetting Started Guide to install ESLint.

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

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

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

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

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

Such as:

# Run on two filesnpx eslint file1.js file2.js
1
2

# Run on two filesyarn dlx eslint file1.js file2.js
1
2

# Run on two filespnpm dlx eslint file1.js file2.js
1
2

# Run on two filesbunx eslint file1.js file2.js
1
2

or

# Run on multiple filesnpx eslint lib/**
1
2

# Run on multiple filesyarn dlx eslint lib/**
1
2

# Run on multiple filespnpm dlx eslint lib/**
1
2

# Run on multiple filesbunx 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 nodeglob syntax, you have to quote your parameter (using double quotes if you need it to run in Windows), as follows:

npx eslint"lib/**"
1

yarn dlx eslint"lib/**"
1

pnpm dlx eslint"lib/**"
1

bunx eslint"lib/**"
1

If you are using aflat 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:

npx eslint.
1

yarn dlx eslint.
1

pnpm dlx eslint.
1

bunx eslint.
1

npx eslint
1

yarn dlx eslint
1

pnpm dlx eslint
1

bunx eslint
1

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 asYarn orpnpm to run ESLint. For pnpm usepnpm dlx eslint and for Yarn useyarn 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:

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

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

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

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

OR

npx eslint--global describe,it tests/
1

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

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

bunx eslint--global describe,it tests/
1

Options

You can view all the CLI options by runningnpx 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 optionsSpecify Rules and Plugins:  --plugin [String]                Specify plugins  --rule Object                    Specify rulesFix 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 ignoreUse stdin:  --stdin                          Lint code provided on <STDIN> - default: false  --stdin-filename String          Specify filename to process STDIN asHandle Warnings:  --quiet                          Report errors only - default: false  --max-warnings Int               Number of warnings to trigger nonzero exit code - default: -1Output:  -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 colorInline 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 2Caching:  --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: metadataSuppressing 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: falseMiscellaneous:  --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  --concurrency Int|String         Number of linting threads, auto to choose automatically, off for no multithreading - default: off
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

Basic Configuration

--no-config-lookup

Flat Config Mode Only. Disables use of configuration from files.

• Argument Type: No argument.

--no-config-lookup example

npx eslint --no-config-lookup file.js
1

yarn dlx eslint --no-config-lookup file.js
1

pnpm dlx eslint --no-config-lookup file.js
1

bunx eslint --no-config-lookup file.js
1

--no-eslintrc

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

• Argument Type: No argument.

--no-eslintrc example

npx eslint --no-eslintrc file.js
1

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

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

bunx eslint --no-eslintrc file.js
1

-c,--config

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

• Argument Type: String. Path to file.
• Multiple Arguments: No

-c,--config example

npx eslint-c ~/my.eslint.config.js file.js
1

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

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

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 aneslint.config.js file.

--inspect-config

Flat Config Mode Only. This option runsnpx @eslint/config-inspector@latest to start theconfig 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.

• Argument Type: No argument.

--inspect-config example

npx eslint --inspect-config
1

yarn dlx eslint --inspect-config
1

pnpm dlx eslint --inspect-config
1

bunx eslint --inspect-config
1

--env

eslintrc Mode Only. This option enables specific environments.

• Argument Type: String. One of the available environments.
• Multiple Arguments: Yes

Details about the global variables defined by each environment are available in theSpecifying 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

npx eslint--env browser,node file.js
1

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

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

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

npx eslint--env browser--envnode file.js
1

yarn dlx eslint--env browser--envnode file.js
1

pnpm dlx eslint--env browser--envnode file.js
1

bunx eslint--env browser--envnode file.js
1

--ext

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

• Argument Type: String. File extension.
• Multiple Arguments: Yes
• Default Value: By default, ESLint lints files with extensions.js,.mjs,.cjs, and additional extensionsspecified in the configuration file.

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

# Include .ts filesnpx eslint.--ext .ts
1
2

# Include .ts filesyarn dlx eslint.--ext .ts
1
2

# Include .ts filespnpm dlx eslint.--ext .ts
1
2

# Include .ts filesbunx eslint.--ext .ts
1
2

# Include .ts and .tsx filesnpx eslint.--ext .ts--ext .tsx
1
2

# Include .ts and .tsx filesyarn dlx eslint.--ext .ts--ext .tsx
1
2

# Include .ts and .tsx filespnpm dlx eslint.--ext .ts--ext .tsx
1
2

# Include .ts and .tsx filesbunx eslint.--ext .ts--ext .tsx
1
2

# Also include .ts and .tsx filesnpx eslint.--ext .ts,.tsx
1
2

# Also include .ts and .tsx filesyarn dlx eslint.--ext .ts,.tsx
1
2

# Also include .ts and .tsx filespnpm dlx eslint.--ext .ts,.tsx
1
2

# Also include .ts and .tsx filesbunx eslint.--ext .ts,.tsx
1
2

--global

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

• Argument Type: String. Name of the global variable. Any specified global variables are assumed to be read-only by default, but appending:true to a variable’s name ensures thatno-undef also allows writes.
• Multiple Arguments: Yes

--global example

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

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

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

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

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

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

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

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

--parser

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

• Argument Type: String. Parser to be used by ESLint.
• Multiple Arguments: No
• Default Value:espree

--parser example

# Use TypeScript ESLint parsernpx eslint--parser @typescript-eslint/parser file.ts
1
2

# Use TypeScript ESLint parseryarn dlx eslint--parser @typescript-eslint/parser file.ts
1
2

# Use TypeScript ESLint parserpnpm dlx eslint--parser @typescript-eslint/parser file.ts
1
2

# Use TypeScript ESLint parserbunx 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.

• Argument Type: Key/value pair separated by colon (:).
• Multiple Arguments: Yes

--parser-options example

# fails with a parsing errorecho'3 ** 4'| npx eslint--stdin --parser-options ecmaVersion:6
1
2

# fails with a parsing errorecho'3 ** 4'|yarn dlx eslint--stdin --parser-options ecmaVersion:6
1
2

# fails with a parsing errorecho'3 ** 4'|pnpm dlx eslint--stdin --parser-options ecmaVersion:6
1
2

# fails with a parsing errorecho'3 ** 4'| bunx eslint--stdin --parser-options ecmaVersion:6
1
2

# succeeds, yay!echo'3 ** 4'| npx eslint--stdin --parser-options ecmaVersion:7
1
2

# succeeds, yay!echo'3 ** 4'|yarn dlx eslint--stdin --parser-options ecmaVersion:7
1
2

# succeeds, yay!echo'3 ** 4'|pnpm dlx eslint--stdin --parser-options ecmaVersion:7
1
2

# succeeds, yay!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.

• Argument Type: String. Path to directory.
• Multiple Arguments: No
• Default Value: By default, plugins are resolved from the directory in which your configuration file is found.

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:

• When using a config file that is located outside of the current project (with the--config flag), if the config uses plugins which are installed locally to itself,--resolve-plugins-relative-to should be set to the directory containing the config file.
• If an integration has dependencies on ESLint and a set of plugins, and the tool invokes ESLint on behalf of the user with a preset configuration, the tool should set--resolve-plugins-relative-to to the top-level directory of the tool.

--resolve-plugins-relative-to example

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

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

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

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.

• Argument Type: String. Plugin name. You can optionally omit the prefixeslint-plugin- from the plugin name.
• Multiple Arguments: Yes

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

--plugin example

npx eslint--plugin jquery file.js
1

yarn dlx eslint--plugin jquery file.js
1

pnpm dlx eslint--plugin jquery file.js
1

bunx eslint--plugin jquery file.js
1

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

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

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

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

--rule

This option specifies the rules to be used.

• Argument Type: Rules and their configuration specified withlevn format.
• Multiple Arguments: Yes

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 configuration files and only run rules specified in the command line, use the--rule flag in combination with the--no-config-lookup flag.

--rule example

# Apply single rulenpx eslint--rule'quotes: [error, double]'
1
2

# Apply single ruleyarn dlx eslint--rule'quotes: [error, double]'
1
2

# Apply single rulepnpm dlx eslint--rule'quotes: [error, double]'
1
2

# Apply single rulebunx eslint--rule'quotes: [error, double]'
1
2

# Apply multiple rulesnpx eslint--rule'guard-for-in: error'--rule'brace-style: [error, 1tbs]'
1
2

# Apply multiple rulesyarn dlx eslint--rule'guard-for-in: error'--rule'brace-style: [error, 1tbs]'
1
2

# Apply multiple rulespnpm dlx eslint--rule'guard-for-in: error'--rule'brace-style: [error, 1tbs]'
1
2

# Apply multiple rulesbunx eslint--rule'guard-for-in: error'--rule'brace-style: [error, 1tbs]'
1
2

# Apply rule from jquery pluginnpx eslint--rule'jquery/dollar-sign: error'
1
2

# Apply rule from jquery pluginyarn dlx eslint--rule'jquery/dollar-sign: error'
1
2

# Apply rule from jquery pluginpnpm dlx eslint--rule'jquery/dollar-sign: error'
1
2

# Apply rule from jquery pluginbunx eslint--rule'jquery/dollar-sign: error'
1
2

# Only apply rule from the command linenpx eslint--rule'quotes: [error, double]' --no-config-lookup
1
2

# Only apply rule from the command lineyarn dlx eslint--rule'quotes: [error, double]' --no-config-lookup
1
2

# Only apply rule from the command linepnpm dlx eslint--rule'quotes: [error, double]' --no-config-lookup
1
2

# Only apply rule from the command linebunx eslint--rule'quotes: [error, double]' --no-config-lookup
1
2

--rulesdir

Deprecated: Userules from custom 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.

• Argument Type: String. Path to directory. The rules in your custom rules directory must follow the same format as bundled rules to work properly.
• Multiple Arguments: Yes

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

npx eslint--rulesdir my-rules/ file.js
1

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

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

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

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

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

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

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

Fix Problems

--fix

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

• Argument Type: No argument.

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 fromstdin or otherwise want to get the fixes without actually writing them to the file, use the--fix-dry-run option.

--fix example

npx eslint--fix file.js
1

yarn dlx eslint--fix file.js
1

pnpm dlx eslint--fix file.js
1

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.

• Argument Type: No argument.

This makes it possible to fix code fromstdin 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

getSomeText| npx eslint--stdin --fix-dry-run--format json
1

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

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

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.

• Argument Type: String. One of the following fix types:
  1. problem - fix potential errors in the code
  2. suggestion - apply fixes to the code that improve it
  3. layout - apply fixes that do not change the program structure (AST)
  4. directive - apply fixes to inline directives such as// eslint-disable
• Multiple Arguments: Yes

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

npx eslint--fix --fix-type suggestion.
1

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

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

bunx eslint--fix --fix-type suggestion.
1

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

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

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

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

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

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

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

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.

• Argument Type: String. Path to file.
• Multiple Arguments: No
• Default Value: By default, ESLint looks for.eslintignore in the current working directory.

Note:--ignore-path is only supported when usingdeprecated configuration. If you want to include patterns from a.gitignore file in youreslint.config.js file, please seeincluding.gitignore files.

--ignore-path example

npx eslint --ignore-path tmp/.eslintignore file.js
1

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

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

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

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

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

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

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

--no-ignore

Disables excluding of files from--ignore-pattern flags and theignores property in configuration. In eslintrc mode,.eslintignore files,--ignore-path flags, and theignorePatterns property in configuration are also disabled.

• Argument Type: No argument.

--no-ignore example

npx eslint --no-ignore file.js
1

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

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

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.

• Argument Type: String. The supported syntax is the same as forignores patterns, which useminimatch syntax. In eslintrc mode, the syntax is the same as for.eslintignore files, which use the same patterns as the.gitignore specification. You should quote your patterns in order to avoid shell interpretation of glob patterns.
• Multiple Arguments: Yes

--ignore-pattern example

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

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

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

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.

• Argument Type: No argument.

--stdin example

cat myFile.js| npx eslint--stdin
1

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

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

cat myFile.js| bunx eslint--stdin
1

--stdin-filename

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

• Argument Type: String. Path to file.
• Multiple Arguments: No

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

--stdin-filename example

cat myFile.js| npx eslint--stdin --stdin-filename myfile.js
1

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

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

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.

• Argument Type: No argument.

--quiet example

npx eslint--quiet file.js
1

yarn dlx eslint--quiet file.js
1

pnpm dlx eslint--quiet file.js
1

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.

• Argument Type: Integer. The maximum number of warnings to allow. To prevent this behavior, do not use this option or specify-1 as the argument.
• Multiple Arguments: No

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.

npx eslint --max-warnings10 file.js
1

yarn dlx eslint --max-warnings10 file.js
1

pnpm dlx eslint --max-warnings10 file.js
1

bunx eslint --max-warnings10 file.js
1

npx eslint-o ./test/test.html
1

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

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

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

• Argument Type: String. One of thebuilt-in formatters or a custom formatter.
• Multiple Arguments: No
• Default Value:stylish

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 withouteslint-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:

# Saves the output into the `results.json` file.npx eslint-f json file.js> results.json
1
2

# Saves the output into the `results.json` file.yarn dlx eslint-f json file.js> results.json
1
2

# Saves the output into the `results.json` file.pnpm dlx eslint-f json file.js> results.json
1
2

# Saves the output into the `results.json` file.bunx eslint-f json file.js> results.json
1
2

-f,--format example

Use the built-injson formatter:

npx eslint--format json file.js
1

yarn dlx eslint--format json file.js
1

pnpm dlx eslint--format json file.js
1

bunx eslint--format json file.js
1

Use a local custom formatter:

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

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

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

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

Use an npm-installed formatter:

npminstall eslint-formatter-pretty
1

yarnadd eslint-formatter-pretty
1

pnpmadd eslint-formatter-pretty
1

bunadd eslint-formatter-pretty
1

Then run one of the following commands

npx eslint-f pretty file.js
1

yarn dlx eslint-f pretty file.js
1

pnpm dlx eslint-f pretty file.js
1

bunx eslint-f pretty file.js
1

or alternatively

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

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

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

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

--color and--no-color

These options force the enabling/disabling of colorized output.

• Argument Type: No argument.

You can use these options to override the default behavior, which is to enable colorized output unless no TTY is detected, such as when pipingeslint throughcat orless.

--color and--no-color example

npx eslint--color file.js|cat
1

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

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

bunx eslint--color file.js|cat
1

npx eslint --no-color file.js
1

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

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

bunx eslint --no-color file.js
1

Inline Configuration Comments

--no-inline-config

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

• Argument Type: No argument.

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

• /*eslint-disable*/
• /*eslint-enable*/
• /*global*/
• /*eslint*/
• /*eslint-env*/
• // eslint-disable-line
• // eslint-disable-next-line

--no-inline-config example

npx eslint --no-inline-config file.js
1

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

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

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.

• Argument Type: No argument.

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

npx eslint --report-unused-disable-directives file.js
1

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

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

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

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.

• Argument Type: String. One of the following values:
  1. off (or0)
  2. warn (or1)
  3. error (or2)
• Multiple Arguments: No
• Default Value: By default,linterOptions.reportUnusedDisableDirectives configuration setting is used (which defaults to"warn").

--report-unused-disable-directives-severity example

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

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

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

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.

• Argument Type: String. One of the following values:
  1. off (or0)
  2. warn (or1)
  3. error (or2)
• Multiple Arguments: No
• Default Value: By default,linterOptions.reportUnusedInlineConfigs configuration setting is used (which defaults to"off").

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.

• Argument Type: No argument.

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

npx eslint--cache file.js
1

yarn dlx eslint--cache file.js
1

pnpm dlx eslint--cache file.js
1

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 theeslint command is executed.

--cache-location

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

• Argument Type: String. Path to file or directory. If a directory is specified, a cache file is created inside the specified folder. The name of the file is based on the hash of the current working directory, e.g.:.cache_hashOfCWD.
• Multiple Arguments: No
• Default Value: If no location is specified,.eslintcache is used. The file is created in the directory where theeslint command is executed.

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

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

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

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

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

--cache-strategy

Strategy for the cache to use for detecting changed files.

• Argument Type: String. One of the following values:
  1. metadata
  2. content
• Multiple Arguments: No
• Default Value:metadata

Thecontent 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 likegit clone because git does not track file modification time.

--cache-strategy example

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

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

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

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 ineslint-suppressions.json by default, unless otherwise specified by--suppressions-location. The file gets updated with the new suppressions.

• Argument Type: No argument.

--suppress-all example

npx eslint"src/**/*.js" --suppress-all
1

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

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

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 ineslint-suppressions.json by default, unless otherwise specified by--suppressions-location. The file gets updated with the new suppressions.

• Argument Type: String. Rule ID.
• Multiple Arguments: Yes

--suppress-rule example

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

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

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

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.

• Argument Type: String. Path to file. If a directory is specified, a cache file is created inside the specified folder. The name of the file is based on the hash of the current working directory, e.g.:suppressions_hashOfCWD
• Multiple Arguments: No
• Default Value: If no location is specified,eslint-suppressions.json is used. The file is created in the directory where theeslint command is executed.

--suppressions-location example

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

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

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

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.

• Argument Type: No argument.

--prune-suppressions example

npx eslint"src/**/*.js" --prune-suppressions
1

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

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

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

--pass-on-unpruned-suppressions

Ignore unused suppressions. By default, ESLint exits with exit code2 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.

• Argument Type: No argument.

--pass-on-unpruned-suppressions example

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

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

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

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

Miscellaneous

--init

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

• Argument Type: No argument.

The resulting configuration file is created in the current directory.

--init example

npx eslint--init
1

yarn dlx eslint--init
1

pnpm dlx eslint--init
1

bunx eslint--init
1

--env-info

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

• Argument Type: No argument.

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

npx eslint --env-info
1

yarn dlx eslint --env-info
1

pnpm dlx eslint --env-info
1

bunx 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.

• Argument Type: No argument.

--no-error-on-unmatched-pattern example

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

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

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

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.

• Argument Type: No argument.

--exit-on-fatal-error example

npx eslint --exit-on-fatal-error file.js
1

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

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

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

--no-warn-ignored

Flat Config Mode Only. This option suppresses bothFile ignored by default andFile 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.

• Argument Type: No argument.

--no-warn-ignored example

npx eslint --no-warn-ignored --max-warnings0 ignored-file.js
1

yarn dlx eslint --no-warn-ignored --max-warnings0 ignored-file.js
1

pnpm dlx eslint --no-warn-ignored --max-warnings0 ignored-file.js
1

bunx eslint --no-warn-ignored --max-warnings0 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.)

• Argument Type: No argument.

--pass-on-no-patterns example

npx eslint --pass-on-no-patterns
1

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

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

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.

• Argument Type: No argument.

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

npx eslint--debug test.js
1

yarn dlx eslint--debug test.js
1

pnpm dlx eslint--debug test.js
1

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.

• Argument Type: No argument.

-h,--help example

npx eslint--help
1

yarn dlx eslint--help
1

pnpm dlx eslint--help
1

bunx eslint--help
1

-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.

• Argument Type: No argument.

-v,--version example

npx eslint--version
1

yarn dlx eslint--version
1

pnpm dlx eslint--version
1

bunx 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.

• Argument Type: String. Path to file.
• Multiple Arguments: No

--print-config example

npx eslint --print-config file.js
1

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

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

bunx eslint --print-config file.js
1

--stats

This option adds a series of detailed performance statistics (seeStats type) such as theparse-,fix- andlint-times (time per rule) toresult objects that are passed to the formatter (seeStats CLI usage).

• Argument Type: No argument.

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

--stats example

npx eslint--stats--format json file.js
1

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

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

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

--flag

This option enables one or more feature flags for ESLint.

• Argument Type: String. A feature identifier.
• Multiple Arguments: Yes

--flag example

npx eslint--flag x_feature file.js
1

yarn dlx eslint--flag x_feature file.js
1

pnpm dlx eslint--flag x_feature file.js
1

bunx eslint--flag x_feature file.js
1

--mcp

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

• Argument Type: No argument.
• Multiple Arguments: No

--mcp example

npx eslint--mcp
1

yarn dlx eslint--mcp
1

pnpm dlx eslint--mcp
1

bunx eslint--mcp
1

--concurrency

This option controls the number of worker threads used to lint files.

• Argument Type: Int|String. A positive integer,auto oroff.
• Multiple Arguments: No
• Default Value:off

The valueoff causes all files to be linted in the main thread. The valueauto attempts to determine the best setting automatically.

--concurrency example

npx eslint--concurrency auto
1

yarn dlx eslint--concurrency auto
1

pnpm dlx eslint--concurrency auto
1

bunx eslint--concurrency auto
1

Exit Codes

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

• 0: Linting was successful and there are no linting errors. If the--max-warnings flag is set ton, the number of linting warnings is at mostn.
• 1: Linting was successful and there is at least one linting error, or there are more linting warnings than allowed by the--max-warnings option.
• 2: Linting was unsuccessful due to a configuration problem or an internal error.