Skip to content

Commit 3945c44

Browse files
authored
docs: add CLI options (#3014)
1 parent 599b63e commit 3945c44

File tree

1 file changed

+52
-1
lines changed

1 file changed

+52
-1
lines changed

README.md

+52-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,58 @@ The easiest way to use it is with the [webpack CLI](https://webpack.js.org/api/c
5858
node_modules/.bin/webpack serve
5959
```
6060

61-
_**Note**: Many CLI options are available with `webpack serve`. Explore this [link](https://webpack.js.org/configuration/dev-server/)._
61+
Following options are available with `webpack serve`:
62+
63+
```
64+
Options:
65+
-c, --config <value...> Provide path to a webpack configuration file e.g. ./webpack.config.js.
66+
--config-name <value...> Name of the configuration to use.
67+
-m, --merge Merge two or more configurations using 'webpack-merge'.
68+
--env <value...> Environment passed to the configuration when it is a function.
69+
--progress [value] Print compilation progress during build.
70+
-j, --json [value] Prints result as JSON or store it in a file.
71+
-d, --devtool <value> Determine source maps to use.
72+
--no-devtool Do not generate source maps.
73+
--entry <value...> The entry point(s) of your application e.g. ./src/main.js.
74+
--mode <value> Defines the mode to pass to webpack.
75+
--name <value> Name of the configuration. Used when loading multiple configurations.
76+
-o, --output-path <value> Output location of the file generated by webpack e.g. ./dist/.
77+
--stats [value] It instructs webpack on how to treat the stats e.g. verbose.
78+
--no-stats Disable stats output.
79+
-t, --target <value...> Sets the build target e.g. node.
80+
--watch-options-stdin Stop watching when stdin stream has ended.
81+
--no-watch-options-stdin Do not stop watching when stdin stream has ended.
82+
--host <value> The hostname/ip address the server will bind to
83+
--port <value> The port
84+
--static [value...] A directory to serve static content from.
85+
--no-static Negative 'static' option.
86+
--live-reload Enables/Disables live reloading on changing files
87+
--no-live-reload Negative 'live-reload' option.
88+
--https HTTPS
89+
--http2 HTTP/2, must be used with HTTPS
90+
--bonjour Broadcasts the server via ZeroConf networking on start
91+
--client-progress Print compilation progress in percentage in the browser
92+
--hot-only Do not refresh page if HMR fails
93+
--setup-exit-signals Close and exit the process on SIGINT and SIGTERM
94+
--no-setup-exit-signals Negative 'setup-exit-signals' option.
95+
--stdin Close when stdin ends
96+
--open [value] Open the default browser, or optionally specify a browser name
97+
--use-local-ip Open default browser with local IP
98+
--open-page <value...> Open default browser with the specified page
99+
--client-logging <value> Log level in the browser (none, error, warn, info, log, verbose)
100+
--history-api-fallback Fallback to /index.html for Single Page Applications.
101+
--compress Enable gzip compression
102+
--public <value> The public hostname/ip address of the server
103+
--firewall <value...> Enable/disable firewall, or set hosts that are allowed to access the dev server
104+
105+
Global options:
106+
--color Enable colors on console.
107+
--no-color Disable colors on console.
108+
-v, --version Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
109+
-h, --help [verbose] Display help for commands and options.
110+
```
111+
112+
_**Note**: For more information on above options explore this [link](https://webpack.js.org/configuration/dev-server/)._
62113

63114
### With NPM Scripts
64115

0 commit comments

Comments
 (0)