Skip to content

Commit e10c2a0

Browse files
snitin315snitin315
authored
docs: update cli options (#3239)
1 parent 469e558 commit e10c2a0

File tree

1 file changed

+59
-53
lines changed

1 file changed

+59
-53
lines changed

‎README.md

Lines changed: 59 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -64,61 +64,67 @@ Following options are available with `webpack serve`:
6464
Usage: webpack serve|s [entries...] [options]
6565
6666
Options:
67-
-c, --config <value...> Provide path to a webpack configuration file e.g. ./webpack.config.js.
68-
--config-name <value...> Name of the configuration to use.
69-
-m, --merge Merge two or more configurations using 'webpack-merge'.
70-
--env <value...> Environment passed to the configuration when it is a function.
71-
--node-env <value> Sets process.env.NODE_ENV to the specified value.
72-
--progress [value] Print compilation progress during build.
73-
-j, --json [value] Prints result as JSON or store it in a file.
74-
-d, --devtool <value> Determine source maps to use.
75-
--no-devtool Do not generate source maps.
76-
--entry <value...> The entry point(s) of your application e.g. ./src/main.js.
77-
--mode <value> Defines the mode to pass to webpack.
78-
--name <value> Name of the configuration. Used when loading multiple configurations.
79-
-o, --output-path <value> Output location of the file generated by webpack e.g. ./dist/.
80-
--stats [value] It instructs webpack on how to treat the stats e.g. verbose.
81-
--no-stats Disable stats output.
82-
-t, --target <value...> Sets the build target e.g. node.
83-
--no-target Negative 'target' option.
84-
--watch-options-stdin Stop watching when stdin stream has ended.
85-
--no-watch-options-stdin Do not stop watching when stdin stream has ended.
86-
--host <value> The hostname/ip address the server will bind to.
87-
--port <value> The port server will listen to.
88-
--static [value...] A directory to serve static content from.
89-
--no-static Negative 'static' option.
90-
--live-reload Enables live reloading on changing files.
91-
--no-live-reload Disables live reloading on changing files.
92-
--https Use HTTPS protocol.
93-
--no-https Do not use HTTPS protocol.
94-
--http2 Use HTTP/2, must be used with HTTPS.
95-
--no-http2 Do not use HTTP/2.
96-
--bonjour Broadcasts the server via ZeroConf networking on start.
97-
--no-bonjour Do not broadcast the server via ZeroConf networking on start.
98-
--client-progress Print compilation progress in percentage in the browser.
99-
--no-client-progress Do not print compilation progress in percentage in the browser.
100-
--client-overlay Show a full-screen overlay in the browser when there are compiler errors or warnings.
101-
--no-client-overlay Do not show a full-screen overlay in the browser when there are compiler errors or warnings.
102-
--open [value...] Open the default browser.
103-
--no-open Do not open the default browser.
104-
--open-app <value> Open specified browser.
105-
--open-target [value...] Open specified route in browser.
106-
--no-open-target Do not open specified route in browser.
107-
--client-logging <value> Log level in the browser (none, error, warn, info, log, verbose).
108-
--history-api-fallback Fallback to /index.html for Single Page Applications.
109-
--no-history-api-fallback Do not fallback to /index.html for Single Page Applications.
110-
--compress Enable gzip compression.
111-
--no-compress Disable gzip compression.
112-
--public <value> The public hostname/ip address of the server.
113-
--firewall [value...] Enable firewall or set hosts that are allowed to access the dev server.
114-
--no-firewall Disable firewall.
115-
--watch-files <value...> Watch static files for file changes.
67+
-c, --config <value...> Provide path to a webpack configuration file e.g. ./webpack.config.js.
68+
--config-name <value...> Name of the configuration to use.
69+
-m, --merge Merge two or more configurations using 'webpack-merge'.
70+
--env <value...> Environment passed to the configuration when it is a function.
71+
--node-env <value> Sets process.env.NODE_ENV to the specified value.
72+
--progress [value] Print compilation progress during build.
73+
-j, --json [value] Prints result as JSON or store it in a file.
74+
-d, --devtool <value> Determine source maps to use.
75+
--no-devtool Do not generate source maps.
76+
--entry <value...> The entry point(s) of your application e.g. ./src/main.js.
77+
--mode <value> Defines the mode to pass to webpack.
78+
--name <value> Name of the configuration. Used when loading multiple configurations.
79+
-o, --output-path <value> Output location of the file generated by webpack e.g. ./dist/.
80+
--stats [value] It instructs webpack on how to treat the stats e.g. verbose.
81+
--no-stats Disable stats output.
82+
-t, --target <value...> Sets the build target e.g. node.
83+
--no-target Negative 'target' option.
84+
--watch-options-stdin Stop watching when stdin stream has ended.
85+
--no-watch-options-stdin Do not stop watching when stdin stream has ended.
86+
--host <value> The hostname/ip address the server will bind to.
87+
--port <value> The port server will listen to.
88+
--static [value...] A directory to serve static content from.
89+
--no-static Negative 'static' option.
90+
--static-directory <value> Directory for static contents.
91+
--static-public-path <value...> The bundled files will be available in the browser under this path.
92+
--static-serve-index Tells dev-server to use serveIndex middleware.
93+
--no-static-serve-index Do not tell dev-server to use serveIndex middleware.
94+
--static-watch Watch for files in static content directory.
95+
--no-static-watch Do not watch for files in static content directory.
96+
--live-reload Enables live reloading on changing files.
97+
--no-live-reload Disables live reloading on changing files.
98+
--https Use HTTPS protocol.
99+
--no-https Do not use HTTPS protocol.
100+
--http2 Use HTTP/2, must be used with HTTPS.
101+
--no-http2 Do not use HTTP/2.
102+
--bonjour Broadcasts the server via ZeroConf networking on start.
103+
--no-bonjour Do not broadcast the server via ZeroConf networking on start.
104+
--client-progress Print compilation progress in percentage in the browser.
105+
--no-client-progress Do not print compilation progress in percentage in the browser.
106+
--client-overlay Show a full-screen overlay in the browser when there are compiler errors or warnings.
107+
--no-client-overlay Do not show a full-screen overlay in the browser when there are compiler errors or warnings.
108+
--open [value...] Open the default browser.
109+
--no-open Do not open the default browser.
110+
--open-app <value> Open specified browser.
111+
--open-target [value...] Open specified route in browser.
112+
--no-open-target Do not open specified route in browser.
113+
--client-logging <value> Log level in the browser (none, error, warn, info, log, verbose).
114+
--history-api-fallback Fallback to /index.html for Single Page Applications.
115+
--no-history-api-fallback Do not fallback to /index.html for Single Page Applications.
116+
--compress Enable gzip compression.
117+
--no-compress Disable gzip compression.
118+
--public <value> The public hostname/ip address of the server.
119+
--firewall [value...] Enable firewall or set hosts that are allowed to access the dev server.
120+
--no-firewall Disable firewall.
121+
--watch-files <value...> Watch static files for file changes.
116122
117123
Global options:
118-
--color Enable colors on console.
119-
--no-color Disable colors on console.
120-
-v, --version Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
121-
-h, --help [verbose] Display help for commands and options.
124+
--color Enable colors on console.
125+
--no-color Disable colors on console.
126+
-v, --version Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
127+
-h, --help [verbose] Display help for commands and options.
122128
```
123129

124130
_**Note**: For more information on above options explore this [link](https://webpack.js.org/configuration/dev-server/)._

0 commit comments

Comments
 (0)