A CLI for webpack-plugin-serve, providing a premier webpack development server

License: MPL-2.0

Language: JavaScript


tests cover size


A CLI for webpack-plugin-serve - A Webpack development server in a plugin.

(While using a CLI such as webpack-serve is convenient, we recommend using webpack-plugin-serve directly in your webpack config, with webpack-nano, instead.)

Please consider donating if you find this project useful.


webpack-serve is an evergreen 🌲 module.

This module requires an Active LTS Node version (v8.0.0+ or v10.0.0+). The client scripts in this module require browsers which support async/await. Users may also choose to compile the client script via an appropriately configured Babel webpack loader for use in older browsers.

Feature Parity

Since this CLI leverages webpack-plugin-serve, the same feature parity information applies. Please see the webpack-plugin-serve Feature Comparison for more information.


Using npm:

npm install webpack-serve --save-dev


A CLI for webpack-plugin-serve, providing a premier webpack development server

  $ webpack-serve [...options]

  --all               Apply webpack-plugin-serve to all compilers in the config
  --client.address    Overrides the WebSocket address in the client
  --client.retry      Instructs the client to attempt to reconnect all WebSockets when interrupted
  --client.silent     Instructs the client not to log anything to the console.
  --compress          Enables compression middleware which serves files with GZip compression.
  --config            A path to a webpack config file
  --config.{name}     A path to a webpack config file, and the config name to run
  --help              Displays this message
  --history-fallback  Enables History API Fallback
  --hmr               Enables Hot Module Replacement. On by default
  --host              Sets the host the server should listen from
  --http2             Instructs the server to enable HTTP2
  --live-reload       Instructs the client to perform a full page reload after each build
  --no-watch          Does not apply \`watch: true\` to the config, allowing for greater customization
  --open              Opens the default browser to the set host and port
  --port              Sets the port on which the server should listen
  --progress          Shows build progress in the client
  --silent            Instruct the CLI to produce no console output
  --static            Sets the directory from which static files will be served
  --status            Shows build status (errors, warnings) in the client
  --version           Displays webpack-nano and webpack versions
  --wait-for-build    Instructs the server to halt middleware processing until the current build is done.

  $ webpack-serve
  $ webpack-serve --help
  $ webpack-serve --config webpack.config.js
  $ webpack-serve --config.serve webpack.config.js


Please reference the webpack-plugin-serve Options for information and use. Most options are analogous to the flags listed above.


By 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.

package.json Options

For 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 for information and use.

For Example:

	"name": "some-package",
	"version": "1.0.0",
	"serve": {
    "host": ""

Advanced Options

For 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 directly in your webpack config, along with webpack-nano.



LICENSE (Mozilla Public License)

Project Statistics

Sourcerank 14
Repository Size 1.1 MB
Stars 25
Forks 5
Watchers 3
Open issues 0
Dependencies 909
Contributors 30
Tags 25
Last updated
Last pushed

Top Contributors See all

Andrew Powell Evilebot Tnawi Justin Hall Billy Janitsch ferdinando-ferreira Juho Vepsäläinen Matthew Francis Brunetti Eli Sherer Phil Ostler Andrew Lisowski Neo Nie Darrin Massena Bud (Mugur) Chirica JounQin Olegs Jeremejevs Norbert de Langen Matheus Gonçalves da Silva tjallingt Brod Gary Kaganas

Packages Referencing this Repo

A lean, modern, and flexible webpack development server
Latest release 2.0.3 - Published - 25 stars
A CLI for webpack-plugin-serve, providing a premier webpack development server
Latest release 3.2.0 - Updated - 25 stars

Recent Tags See all

v3.2.0 September 19, 2019
v3.1.1 July 21, 2019
v3.1.0 April 08, 2019
v3.0.0 April 01, 2019
v3.0.0-beta.3 March 14, 2019
v3.0.0-beta.2 March 14, 2019
v2.0.3 November 20, 2018
v2.0.2 July 09, 2018
v2.0.1 July 09, 2018
v2.0.0 July 09, 2018
v1.0.4 June 08, 2018
v1.0.3 June 07, 2018
v1.0.2 May 13, 2018
v1.0.1 May 13, 2018
v1.0.0 May 13, 2018

Something wrong with this page? Make a suggestion

Last synced: 2019-09-19 15:33:42 UTC

Login to resync this repository