Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kaicataldo committed Sep 16, 2019
1 parent 2631f21 commit 654d543
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/user-guide/command-line-interface.md
Expand Up @@ -78,6 +78,7 @@ Caching:
Miscellaneous:
--init Run config initialization wizard - default: false
--info Output execution environment information - default: false
--debug Output debugging information
-h, --help Show help
-v, --version Output the version number
Expand Down Expand Up @@ -446,6 +447,10 @@ This option will start config initialization wizard. It's designed to help new u

The resulting configuration file will be created in the current directory.

#### `--info`

This option outputs information about the execution environment, including the version of Node, npm, and local and global installations of ESLint. The ESLint team may ask for this information to help solve bugs.

#### `--debug`

This option outputs debugging information to the console. 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.
Expand Down
2 changes: 1 addition & 1 deletion lib/options.js
Expand Up @@ -228,7 +228,7 @@ module.exports = optionator({
option: "info",
type: "Boolean",
default: "false",
description: "Output environment information for debugging purposes"
description: "Output execution environment information"
},
{
option: "debug",
Expand Down

0 comments on commit 654d543

Please sign in to comment.