webpack-cli

What is webpack-cli?

The webpack-cli npm package provides a command-line interface for the webpack bundler, which allows developers to interact with webpack and its features directly from the command line. It enables tasks such as creating a new webpack project, managing configurations, running the development server, and more.

What are webpack-cli's main functionalities?

Initializing a new webpack project

This command sets up a new webpack project by generating a default configuration file. It can also install webpack and related dependencies if they are not already installed.

webpack-cli init

Generating a configuration file

Generates a webpack configuration file based on the user's preferences. It can be used to quickly scaffold a new configuration or to update an existing one.

webpack-cli generate

Running a webpack build

Executes the webpack build process, which bundles the source files according to the webpack configuration. This is typically used for production builds.

webpack-cli build

Starting a development server

Starts the webpack development server, which provides a live reloading environment for development purposes. It watches for file changes and automatically recompiles the project.

webpack-cli serve

Running webpack in watch mode

Runs webpack in watch mode, where it watches for file changes and recompiles the project as necessary. This is useful during development to see changes reflected immediately.

webpack-cli watch

Other packages similar to webpack-cli

parcel-bundler

Parcel is a web application bundler that offers a similar zero-configuration experience to webpack. It focuses on speed and simplicity, with a built-in development server and hot module replacement. Unlike webpack-cli, Parcel does not require a separate CLI package to run commands.

rollup

Rollup is a module bundler for JavaScript that compiles small pieces of code into something larger and more complex, such as a library or application. It is known for its efficient output and tree-shaking capabilities. Rollup's CLI is included in the main package, unlike webpack which separates the CLI.

browserify

Browserify lets you require('modules') in the browser by bundling up all of your dependencies. It is an older tool compared to webpack and focuses on compatibility with Node.js modules. Browserify's CLI is also part of the main package.

README

The official CLI of webpack

webpack CLI

• About
  • How to install
• Getting Started
• webpack CLI Scaffolds
• Commands
  • webpack-cli init
  • webpack-cli add
  • webpack-cli info
  • webpack-cli migrate
  • webpack-cli remove
  • webpack-cli generate-plugin
  • webpack-cli generate-loader
  • webpack-cli serve
  • webpack-cli update
• webpack.config.js
• Contributing and Internal Documentation

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.

Commands

Supporting developers is an important task for webpack CLI. Thus, webpack CLI provides different commands for many common tasks. We organize webpack CLI as a multi-package repository. Every command has a dedicated subfolder in the packages Folder.

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 functionality to create a new webpack.config.js configuration file:

npm i webpack-cli @webpack-cli/init
npx webpack-cli init

You will answer many questions when running the init 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 webpack's 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 an scaffold yourself.

You can read more about Scaffolding or check out the example project How do I compose a webpack-scaffold?.

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.