![\"webpack-serve\"](\"https://raw.githubusercontent.com/shellscape/webpack-serve/master/assets/serve.svg?sanitize=true\")
\n
![](\"https://c5.patreon.com/external/logo/become_a_patron_button@2x.png\"){kind=logo}
\n\n\n_Please consider donating if you find this project useful._\n\n## Requirements\n\n`webpack-serve` is an [evergreen ????](./.github/FAQ.md#what-does-evergreen-mean) module.\n\nThis module requires an [Active LTS](https://github.com/nodejs/Release) Node version (v8.0.0+ or v10.0.0+). The client scripts in this module require [browsers which support `async/await`](https://caniuse.com/#feat=async-functions). Users may also choose to compile the client script via an appropriately configured [Babel](https://babeljs.io/) webpack loader for use in older browsers.\n\n## Feature Parity\n\nSince this CLI leverages `webpack-plugin-serve`, the same feature parity information applies. Please see the [`webpack-plugin-serve` Feature Comparison](https://github.com/shellscape/webpack-plugin-serve/blob/HEAD/.github/FEATURES.md) for more information.\n\n## Install\n\nUsing npm:\n\n```console\nnpm install webpack-serve --save-dev\n```\n\n## Usage\n\n```console\nA CLI for webpack-plugin-serve, providing a premier webpack development server\n\nUsage\n $ webpack-serve [...options]\n\nOptions\n --all Apply webpack-plugin-serve to all compilers in the config\n --client.address Overrides the WebSocket address in the client\n --client.retry Instructs the client to attempt to reconnect all WebSockets when interrupted\n --client.silent Instructs the client not to log anything to the console.\n --compress Enables compression middleware which serves files with GZip compression.\n --config A path to a webpack config file\n --config.{name} A path to a webpack config file, and the config name to run\n --help Displays this message\n --history-fallback Enables History API Fallback\n --hmr Enables Hot Module Replacement. On by default\n --host Sets the host the server should listen from\n --http2 Instructs the server to enable HTTP2\n --live-reload Instructs the client to perform a full page reload after each build\n --no-watch Does not apply \\`watch: true\\` to the config, allowing for greater customization\n --open Opens the default browser to the set host and port\n --port Sets the port on which the server should listen\n --progress Shows build progress in the client\n --silent Instruct the CLI to produce no console output\n --static Sets the directory from which static files will be served\n --status Shows build status (errors, warnings) in the client\n --version Displays webpack-nano and webpack versions\n --wait-for-build Instructs the server to halt middleware processing until the current build is done.\n\nExamples\n $ webpack-serve\n $ webpack-serve --help\n $ webpack-serve --config webpack.config.js\n $ webpack-serve --config.serve webpack.config.js\n```\n\n## Flags\n\nPlease reference the [`webpack-plugin-serve` Options](https://github.com/shellscape/webpack-plugin-serve#options) for information and use. Most options are analogous to the flags listed above.\n\n#### `--no-watch`\n\nBy default, the CLI will apply `watch: true` to the first config in the targeted webpack config file. To customize watching or `watchOptions`, please use this flag and customize the config(s) accordingly.\n\n## package.json Options\n\nFor convenience, `webpack-plugin-serve` options can also be defined in a `package.json` file. This CLI will look for a `serve` key in the nearest `package.json` beginning in the directory containing the specified `webpack.config.js`, up to the current working directory. Please reference the [`webpack-plugin-serve` Options](https://github.com/shellscape/webpack-plugin-serve#options) for information and use.\n\nFor Example:\n\n```json\n{\n\t\"name\": \"some-package\",\n\t\"version\": \"1.0.0\",\n\t\"serve\": {\n \"host\": \"10.10.10.1\"\n }\n}\n```\n\n## Advanced Options\n\nFor options which require providing functions or complex objects like `Promises` which cannot be represented by JSON, nor on the command line, please use [`webpack-plugin-serve`](https://github.com/shellscape/webpack-plugin-serve) directly in your webpack config, along with [`webpack-nano`](https://github.com/shellscape/webpack-nano).\n\n## Meta\n\n[CONTRIBUTING](./.github/CONTRIBUTING.md)\n\n[LICENSE (Mozilla Public License)](./LICENSE)\n","_attachments":{},"homepage":"https://github.com/shellscape/webpack-serve","bugs":{"url":"https://github.com/shellscape/webpack-serve/issues"},"license":"MIT"}