Skip to content

Commit 5f700cf

Browse files
snitin315snitin315
committed
docs: update cli flags
1 parent ca36239 commit 5f700cf

File tree

1 file changed

+99
-99
lines changed

1 file changed

+99
-99
lines changed

‎README.md

Lines changed: 99 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -64,107 +64,107 @@ Following options are available with `webpack serve`:
6464
Usage: webpack serve|server|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-
--allowed-hosts <value...> Set hosts that are allowed to access the dev server.
87-
--allowed-hosts-reset Clear all items provided in allowedHosts configuration.
88-
--bonjour Broadcasts the server via ZeroConf networking on start.
89-
--no-bonjour Do not broadcast the server via ZeroConf networking on start.
90-
--client-transport <value> Allows to set custom transport to communicate with server.
91-
--client-logging <value> Specifies client properties.
92-
--client-progress Print compilation progress in percentage in the browser.
93-
--no-client-progress Do not print compilation progress in percentage in the browser.
94-
--client-overlay Show a full-screen overlay in the browser when there are compiler errors or warnings.
95-
--no-client-overlay Do not show a full-screen overlay in the browser when there are compiler errors or warnings.
96-
--client-overlay-errors Show a full-screen overlay in the browser when there are compiler errors.
97-
--no-client-overlay-errors Negative 'client-overlay-errors' option.
98-
--client-overlay-warnings Show a full-screen overlay in the browser when there are compiler warnings.
99-
--no-client-overlay-warnings Negative 'client-overlay-warnings' option.
100-
--client-need-client-entry Tells devServer to inject a client entry.
101-
--no-client-need-client-entry Negative 'client-need-client-entry' option.
102-
--client-hot-entry Tells devServer to inject a Hot Module Replacement entry.
103-
--no-client-hot-entry Do not tell devServer to inject a Hot Module Replacement entry.
104-
--client-web-socket-url <value> When using dev server and you're proxying dev-server, the client script does not always know where to
105-
connect to.
106-
--client-web-socket-url-host <value> Tells clients connected to devServer to use the provided host.
107-
--client-web-socket-url-port <value> Tells clients connected to devServer to use the provided port.
108-
--client-web-socket-url-path <value> Tells clients connected to devServer to use the provided path to connect.
109-
--web-socket-server <value> Allows to set web socket server and options.
110-
--web-socket-server-type <value> Allows to set web socket server and options.
111-
--compress Enable gzip compression for everything served.
112-
--no-compress Disable gzip compression.
113-
--firewall [value...] Defines routes which are enabled by default, on by default and allows localhost.
114-
--no-firewall Disable firewall.
115-
--firewall-reset Clear all items provided in firewall configuration.
116-
--history-api-fallback When using the HTML5 History API, the index.html page will likely have to be served in place of any 404
117-
responses.
118-
--no-history-api-fallback Negative 'history-api-fallback' option.
119-
--host <value> Specify a host to use. If you want your server to be accessible externally.
120-
--hot [value] Enable webpack's Hot Module Replacement feature.
121-
--no-hot Disable webpack's Hot Module Replacement feature.
122-
--http2 Serve over HTTP/2 using spdy.
123-
--no-http2 Do not use HTTP/2.
124-
--https By default, dev-server will be served over HTTP. It can optionally be served over HTTP/2 with HTTPS.
125-
--no-https Do not use HTTPS protocol.
126-
--https-passphrase <value> Passphrase for a pfx file.
127-
--https-request-cert Request for an SSL certificate.
128-
--no-https-request-cert Do not request for an SSL certificate.
129-
--https-cacert <value> Path to an SSL CA certificate.
130-
--https-key <value> Path to an SSL key.
131-
--https-pfx <value> Path to an SSL pfx file.
132-
--https-cert <value> Path to an SSL certificate.
133-
--live-reload By default, the dev-server will reload/refresh the page when file changes are detected.
134-
--no-live-reload Disables live reloading on changing files.
135-
--open [value...] Tells dev-server to open the browser after server had been started. Set it to true to open your default
136-
browser.
137-
--no-open Do not open the default browser.
138-
--open-target [value...] Open specified route in browser.
139-
--no-open-target Do not open specified route in browser.
140-
--open-app-name <value...> Open specified browser.
141-
--open-app <value> Open specified browser.
142-
--open-reset Clear all items provided in open configuration.
143-
--open-target-reset Clear all items provided in open.target configuration.
144-
--open-app-name-reset Clear all items provided in open.app.name configuration.
145-
--port <value> Specify a port number to listen for requests on.
146-
--public <value> The public hostname/ip address of the server that client script will try to connect to.
147-
--static [value...] It is possible to configure advanced options for serving static files from directory. See the Express
148-
documentation for the possible options.
149-
--no-static Negative 'static' option.
150-
--static-directory <value> Directory for static contents.
151-
--static-public-path <value...> The bundled files will be available in the browser under this path.
152-
--static-serve-index Tells dev-server to use serveIndex middleware when enabled.
153-
--no-static-serve-index Do not tell dev-server to use serveIndex middleware.
154-
--static-watch Watch for files in static content directory.
155-
--no-static-watch Do not watch for files in static content directory.
156-
--static-reset Clear all items provided in static configuration.
157-
--static-public-path-reset Clear all items provided in static.publicPath configuration.
158-
--watch-files <value...> List of files to watch for file changes and serve.
159-
--watch-files-paths <value...> List of files to watch for file changes and serve.
160-
--watch-files-reset Clear all items provided in watchFiles configuration.
161-
--watch-files-paths-reset Clear all items provided in watchFiles.paths configuration.
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+
--allowed-hosts <value...> Defines routes which are enabled by default, on by default and allows localhost/value from the 'host' option/value from the 'client.webSocketURL'
87+
option. https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
88+
--allowed-hosts-reset Clear all items provided in configuration. Defines routes which are enabled by default, on by default and allows localhost/value from the 'host'
89+
option/value from the 'client.webSocketURL' option. https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
90+
--bonjour Broadcasts the server via ZeroConf networking on start. https://webpack.js.org/configuration/dev-server/#devserverbonjour
91+
--no-bonjour Do not broadcast the server via ZeroConf networking on start.
92+
--client-transport <value> Allows to set custom transport to communicate with server.
93+
--client-logging <value> Specifies client properties. https://webpack.js.org/configuration/dev-server/#devserverclient
94+
--client-progress Print compilation progress in percentage in the browser.
95+
--no-client-progress Do not print compilation progress in percentage in the browser.
96+
--client-overlay Show a full-screen overlay in the browser when there are compiler errors or warnings.
97+
--no-client-overlay Do not show a full-screen overlay in the browser when there are compiler errors or warnings.
98+
--client-overlay-errors Show a full-screen overlay in the browser when there are compiler errors.
99+
--no-client-overlay-errors Negative 'client-overlay-errors' option.
100+
--client-overlay-warnings Show a full-screen overlay in the browser when there are compiler warnings.
101+
--no-client-overlay-warnings Negative 'client-overlay-warnings' option.
102+
--client-need-client-entry Tells devServer to inject a client entry.
103+
--no-client-need-client-entry Negative 'client-need-client-entry' option.
104+
--client-hot-entry Tells devServer to inject a Hot Module Replacement entry.
105+
--no-client-hot-entry Do not tell devServer to inject a Hot Module Replacement entry.
106+
--client-web-socket-url <value> When using dev server and you're proxying dev-server, the client script does not always know where to connect to.
107+
--client-web-socket-url-host <value> Tells clients connected to devServer to use the provided host.
108+
--client-web-socket-url-port <value> Tells clients connected to devServer to use the provided port.
109+
--client-web-socket-url-path <value> Tells clients connected to devServer to use the provided path to connect.
110+
--client-web-socket-url-protocol <value> Tells clients connected to devServer to use the provided protocol.
111+
--web-socket-server <value> Allows to set web socket server and options.
112+
--compress Enable gzip compression for everything served. https://webpack.js.org/configuration/dev-server/#devservercompress
113+
--no-compress Disable gzip compression.
114+
--history-api-fallback When using the HTML5 History API, the index.html page will likely have to be served in place of any 404 responses.
115+
https://webpack.js.org/configuration/dev-server/#devserverhistoryapifallback
116+
--no-history-api-fallback Negative 'history-api-fallback' option.
117+
--host <value> Specify a host to use. If you want your server to be accessible externally. https://webpack.js.org/configuration/dev-server/#devserverhost
118+
--hot [value] Enable webpack's Hot Module Replacement feature. https://webpack.js.org/configuration/dev-server/#devserverhot
119+
--no-hot Disable webpack's Hot Module Replacement feature.
120+
--http2 Serve over HTTP/2 using spdy. https://webpack.js.org/configuration/dev-server/#devserverhttp2
121+
--no-http2 Do not use HTTP/2.
122+
--https By default, dev-server will be served over HTTP. It can optionally be served over HTTP/2 with HTTPS.
123+
https://webpack.js.org/configuration/dev-server/#devserverhttps
124+
--no-https Do not use HTTPS protocol.
125+
--https-passphrase <value> Passphrase for a pfx file.
126+
--https-request-cert Request for an SSL certificate.
127+
--no-https-request-cert Do not request for an SSL certificate.
128+
--https-cacert <value> Path to an SSL CA certificate.
129+
--https-key <value> Path to an SSL key.
130+
--https-pfx <value> Path to an SSL pfx file.
131+
--https-cert <value> Path to an SSL certificate.
132+
--live-reload By default, the dev-server will reload/refresh the page when file changes are detected.
133+
https://webpack.js.org/configuration/dev-server/#devserverlivereload
134+
--no-live-reload Disables live reloading on changing files.
135+
--open [value...] Tells dev-server to open the browser after server had been started. Set it to true to open your default browser.
136+
https://webpack.js.org/configuration/dev-server/#devserveropen
137+
--no-open Do not open the default browser.
138+
--open-target [value...] Open specified route in browser.
139+
--no-open-target Do not open specified route in browser.
140+
--open-app-name <value...> Open specified browser.
141+
--open-app <value...> Open specified browser.
142+
--open-reset Clear all items provided in configuration. Tells dev-server to open the browser after server had been started. Set it to true to open your default
143+
browser. https://webpack.js.org/configuration/dev-server/#devserveropen
144+
--open-target-reset Clear all items provided in configuration. Open specified route in browser.
145+
--open-app-name-reset Clear all items provided in configuration. Open specified browser.
146+
--port <value> Specify a port number to listen for requests on. https://webpack.js.org/configuration/dev-server/#devserverport
147+
--static [value...] It is possible to configure advanced options for serving static files from directory. See the Express documentation for the possible options.
148+
https://webpack.js.org/configuration/dev-server/#devserverstatic
149+
--no-static Negative 'static' option.
150+
--static-directory <value...> Directory for static contents.
151+
--static-public-path <value...> The bundled files will be available in the browser under this path.
152+
--static-serve-index Tells dev-server to use serveIndex middleware when enabled.
153+
--no-static-serve-index Do not tell dev-server to use serveIndex middleware.
154+
--static-watch Watch for files in static content directory.
155+
--no-static-watch Do not watch for files in static content directory.
156+
--static-reset Clear all items provided in configuration. It is possible to configure advanced options for serving static files from directory. See the Express
157+
documentation for the possible options. https://webpack.js.org/configuration/dev-server/#devserverstatic
158+
--static-public-path-reset Clear all items provided in configuration. The bundled files will be available in the browser under this path.
159+
--watch-files <value...> List of files to watch for file changes and serve. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles
160+
--watch-files-reset Clear all items provided in configuration. List of files to watch for file changes and serve.
161+
https://webpack.js.org/configuration/dev-server/#devserverwatchfiles
162162
163163
Global options:
164-
--color Enable colors on console.
165-
--no-color Disable colors on console.
166-
-v, --version Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
167-
-h, --help [verbose] Display help for commands and options.
164+
--color Enable colors on console.
165+
--no-color Disable colors on console.
166+
-v, --version Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
167+
-h, --help [verbose] Display help for commands and options.
168168
```
169169

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

0 commit comments

Comments
 (0)