webpack/webpack-cli


Webpack's Command Line Interface

https://webpack.js.org/api/cli

License: MIT

Language: TypeScript

Keywords: ast-transformations, cli, scaffold, webpack


webpack CLI

The official CLI of webpack


npm Build Status Build2 Status deps Code Climate chat on gitter Install Size Downloads lerna GitHub contributors

About

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!

Otherwise npm install --save-dev webpack-cli or yarn add webpack-cli --dev will install it.

Packages

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.

Commands

Supporting developers is an important task for webpack CLI. Thus, webpack CLI provides different commands for many common tasks.

Utilities

The project also has several utility packages which are used by other commands

  • utils - Several utilities used across webpack-cli.
  • generators - Contains all webpack-cli related yeoman generators.
  • webpack-scaffold - Utilities to create a webpack scaffold.

Getting started

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

You can read more about Scaffolding, learn How to compose a webpack-scaffold? or generate one with webpack-scaffold-starter.

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.

Open Collective

If you like webpack, please consider donating to our Open Collective to help us maintain it.

Project Statistics

Sourcerank 21
Repository Size 11.1 MB
Stars 1,508
Forks 263
Watchers 49
Open issues 68
Dependencies 4,158
Contributors 80
Tags 99
Created
Last updated
Last pushed

Top Contributors See all

Even Stensberg Dhruvdutt Jadhav Rishabh Chawla Devid Farinelli Anshuman Verma Pranshu Chittora Hemal Patel Emanuele Abenezer Andrey Okonetchnikov Tamas Lakatos Sendil Kumar N Anix Daniela Valero greenkeeper[bot] Darius Tall Pavithra Kodmad Chen Shenyue Eugene Hlushko Nick Williams

Packages Referencing this Repo

webpack-cli
CLI for webpack & friends
Latest release 4.0.0-alpha-5 - Updated - 1.51K stars
@xigua_front/webpack-cli
CLI for webpack & friends
Latest release 1.0.0 - Published - 1.51K stars
zhufeng-webpack-cli
CLI for webpack & friends
Latest release 3.1.0 - Published - 1.51K stars
ignore-this-dot-js
CLI for webpack & friends
Latest release 0.0.2 - Updated - 1.51K stars
webpack-cli-debugger
CLI for webpack & friends
Latest release 3.1.0 - Published - 1.51K stars

Recent Tags See all

v3.3.5 June 23, 2019
v3.3.4 June 11, 2019
3.3.3 June 07, 2019
@webpack-cli/webpack-scaffold@0.1.8 June 07, 2019
@webpack-cli/utils@0.2.2 June 07, 2019
@webpack-cli/update@0.1.8 June 07, 2019
@webpack-cli/serve@0.1.8 June 07, 2019
@webpack-cli/remove@0.1.8 June 07, 2019
@webpack-cli/migrate@0.1.8 June 07, 2019
@webpack-cli/init@0.2.2 June 07, 2019
@webpack-cli/generators@0.1.8 June 07, 2019
@webpack-cli/generate-plugin@0.1.8 June 07, 2019
@webpack-cli/generate-loader@0.1.8 June 07, 2019
@webpack-cli/add@0.2.2 June 07, 2019
@webpack-cli/webpack-scaffold@0.1.7 June 07, 2019

Something wrong with this page? Make a suggestion

Last synced: 2019-05-04 20:15:07 UTC

Login to resync this repository