The official CLI of webpack
Table of Contents
- Supported arguments and commands
- Getting started
- webpack CLI Scaffolds
- Exit codes and their meanings
- Contributing and Internal Documentation
- Open Collective
webpack CLI provides a flexible set of commands for developers to increase speed when setting up a custom webpack project. As of webpack v4, webpack is not expecting a configuration file, but often developers want to create a more custom webpack configuration based on their use-cases and needs. webpack CLI addresses these needs by providing a set of tools to improve the setup of custom webpack configuration.
How to install
When you have followed the Getting Started guide of webpack then webpack CLI is already installed!
npm install --save-dev webpack-cli or
yarn add webpack-cli --dev will install it.
Supported arguments and commands
Get to know what are the available commands and arguments here.
We organize webpack CLI as a multi-package repository using lerna. Every command has a dedicated subfolder in the
packages folder. Here's a summary of commands provided by the CLI.
Supporting developers is an important task for webpack CLI. Thus, webpack CLI provides different commands for many common tasks.
build|bundle|b [entries...] [options]- Run webpack (default command, can be omitted).
configtest|t [config-path]- Validate a webpack configuration.
help|h [command] [option]- Display help for commands and options.
init|create|new|c|n [generation-path] [options]- Create a new webpack project.
info|i [options]- Returns information related to the local environment.
migrate|m <config-path> [new-config-path]- Migrate project from one version to another.
plugin|p [output-path] [options]- Initiate new plugin project.
loader|l [output-path] [options]- Initiate new loader project.
serve|s [entries...] [options]- Use webpack with a development server that provides live reloading.
version|v [commands...]- Output the version number of
webpack-dev-server, and commands
watch|w [entries...] [options]- Run webpack and watch for files changes.
The project also has several utility packages which are used by other commands
generators- Contains all webpack-cli related yeoman generators.
When you have followed the Getting Started guide of webpack then webpack CLI is already installed! Otherwise, you would need to install webpack CLI and the packages you want to use. If you want to use the
init command to create a new
webpack.config.js configuration file:
npm i webpack-cli @webpack-cli/init npx webpack-cli init
You will be prompted for some questions about what how you want to generate your config file when running the
init command so webpack CLI can provide the best fitting configuration.
webpack CLI Scaffolds
With v3 of webpack CLI, we introduced scaffolding as an integral part of the CLI. Our goal is to simplify the creation of webpack configurations for different purposes. Additionally, sharing such solutions with the community is beneficial and with webpack, we want to allow this. We provide
webpack-scaffold as a utility suite for creating these scaffolds. It contains functions that could be of use for creating a scaffold yourself.
Exit codes and their meanings
||Errors from webpack|
||Configuration/options problem or an internal error|
Contributing and Internal Documentation
The webpack family welcomes any contributor, small or big. We are happy to elaborate, guide you through the source code and find issues you might want to work on! To get started have a look at our documentation on contributing.
If you like webpack, please consider donating to our Open Collective to help us maintain it.