docs: update CLI options & commands

webpack · Jan 24, 2025 · f8e22cf · f8e22cf
1 parent 5a6a70b
commit f8e22cf
Showing 1 changed file with 37 additions and 39 deletions.
diff --git a/packages/webpack-cli/README.md b/packages/webpack-cli/README.md
@@ -63,53 +63,51 @@ npx webpack-cli --help verbose
 ### Available Commands
 
 ```
-  build|bundle|b [entries...] [options]                 Run webpack (default command, can be omitted).
-  configtest|t [config-path]                            Validate a webpack configuration.
-  help|h [command] [option]                             Display help for commands and options.
-  info|i [options]                                      Outputs information about your system.
-  init|create|new|c|n [generation-path] [options]       Initialize a new webpack project.
-  loader|l [output-path] [options]                      Scaffold a loader.
-  plugin|p [output-path] [options]                      Scaffold a plugin.
-  serve|server|s [entries...] [options]                 Run the webpack dev server.
-  version|v [commands...]                               Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
-  watch|w [entries...] [options]                        Run webpack and watch for files changes.
+  build|bundle|b [entries...] [options]  Run webpack (default command, can be omitted).
+  configtest|t [config-path]             Validate a webpack configuration.
+  help|h [command] [option]              Display help for commands and options.
+  info|i [options]                       Outputs information about your system.
+  serve|server|s [entries...] [options]  Run the webpack dev server and watch for source file changes while serving.
+  version|v [options]                    Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
+  watch|w [entries...] [options]         Run webpack and watch for files changes.
 ```
 
 ### Available Options
 
 ```
 Options:
-  -c, --config <value...>                          Provide path to a webpack configuration file e.g. ./webpack.config.js.
-  --config-name <value...>                         Name of the configuration to use.
-  -m, --merge                                      Merge two or more configurations using 'webpack-merge'.
-  --disable-interpret                              Disable interpret for loading the config file.
-  --env <value...>                                 Environment passed to the configuration when it is a function.
-  --node-env <value>                               Sets process.env.NODE_ENV to the specified value.
-  --define-process-env-node-env <value>            Sets process.env.NODE_ENV to the specified value. (Currently an alias for `--node-env`)
-  --analyze                                        It invokes webpack-bundle-analyzer plugin to get bundle information.
-  --progress [value]                               Print compilation progress during build.
-  -j, --json [value]                               Prints result as JSON or store it in a file.
-  --fail-on-warnings                               Stop webpack-cli process with non-zero exit code on warnings from webpack
-  -d, --devtool <value>                            A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map).
-  --no-devtool                                     Negative 'devtool' option.
-  --entry <value...>                               A module that is loaded upon startup. Only the last one is exported.
-  --mode <value>                                   Enable production optimizations or development hints.
-  --name <value>                                   Name of the configuration. Used when loading multiple configurations.
-  -o, --output-path <value>                        The output directory as **absolute path** (required).
-  --stats [value]                                  Stats options object or preset name.
-  --no-stats                                       Negative 'stats' option.
-  -t, --target <value...>                          Environment to build for. Environment to build for. An array of environments to build for all of them when possible.
-  --no-target                                      Negative 'target' option.
-  -w, --watch                                      Enter watch mode, which rebuilds on file change.
-  --no-watch                                       Negative 'watch' option.
-  --watch-options-stdin                            Stop watching when stdin stream has ended.
-  --no-watch-options-stdin                         Negative 'watch-options-stdin' option.
+  -c, --config <pathToConfigFile...>     Provide path to one or more webpack configuration files to process, e.g. "./webpack.config.js".
+  --config-name <name...>                Name(s) of particular configuration(s) to use if configuration file exports an array of multiple configurations.
+  -m, --merge                            Merge two or more configurations using 'webpack-merge'.
+  --disable-interpret                    Disable interpret for loading the config file.
+  --env <value...>                       Environment variables passed to the configuration when it is a function, e.g. "myvar" or "myvar=myval".
+  --node-env <value>                     Sets process.env.NODE_ENV to the specified value for access within the configuration.(Deprecated: Use '--config-node-env' instead)
+  --config-node-env <value>              Sets process.env.NODE_ENV to the specified value for access within the configuration.
+  --analyze                              It invokes webpack-bundle-analyzer plugin to get bundle information.
+  --progress [value]                     Print compilation progress during build.
+  -j, --json [pathToJsonFile]            Prints result as JSON or store it in a file.
+  --fail-on-warnings                     Stop webpack-cli process with non-zero exit code on warnings from webpack.
+  -d, --devtool <value>                  A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map).
+  --no-devtool                           Negative 'devtool' option.
+  --entry <value...>                     A module that is loaded upon startup. Only the last one is exported.
+  -e, --extends <value...>               Path to the configuration to be extended (only works when using webpack-cli).
+  --mode <value>                         Enable production optimizations or development hints.
+  --name <value>                         Name of the configuration. Used when loading multiple configurations.
+  -o, --output-path <value>              The output directory as **absolute path** (required).
+  --stats [value]                        Stats options object or preset name.
+  --no-stats                             Negative 'stats' option.
+  -t, --target <value...>                Environment to build for. Environment to build for. An array of environments to build for all of them when possible.
+  --no-target                            Negative 'target' option.
+  -w, --watch                            Enter watch mode, which rebuilds on file change.
+  --no-watch                             Negative 'watch' option.
+  --watch-options-stdin                  Stop watching when stdin stream has ended.
+  --no-watch-options-stdin               Negative 'watch-options-stdin' option.
 
 Global options:
-  --color                                          Enable colors on console.
-  --no-color                                       Disable colors on console.
-  -v, --version                                    Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
-  -h, --help [verbose]                             Display help for commands and options.
+  --color                                Enable colors on console.
+  --no-color                             Disable colors on console.
+  -v, --version                          Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
+  -h, --help [verbose]                   Display help for commands and options.
 ```
 
 Checkout [`OPTIONS.md`](https://github.com/webpack/webpack-cli/blob/master/OPTIONS.md) to see list of all available options.