webpack-cli
Advanced tools
Package description
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.
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 initGenerating 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 generateRunning 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 buildStarting 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 serveRunning 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 watchParcel 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 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 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.
Changelog
4.4.0 (2021-01-19)
--no-watch-options-stdin (#2288) (4ee8665)argv to configurations when serve command used (#2345) (5070b9b)--stats, --color and --no-color option for serve command (#2312) (73d3fec)configtest command (#2303) (eb7b189)build command (aliases - bundle and b) (7590f66)watch command (#2357) (9693f7d)help command to show option information (#2353) (15eb411)Readme
The official CLI of webpack
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.
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
All interactions with webpack-cli are of the form
npx webpack-cli [command] [options]
If no command is specified then bundle command is used by default
You display basic commands and arguments -
npx webpack-cli --help
To display all supported commands and arguments -
npx webpack-cli --help=verbose
or
npx webpack-cli --help verbose
bundle | b Run webpack
help | h Display help for commands and options
version | v Output version number of the 'webpack', 'webpack-cli' and other related packages
init | c Initialize a new webpack configuration
migrate | m Migrate a configuration to a new version
loader | l Scaffold a loader repository
plugin | p Scaffold a plugin repository
info | i Outputs information about your system and dependencies
serve | s Run the webpack Dev Server
configtest | t Tests webpack configuration against validation errors.
--analyze It invokes webpack-bundle-analyzer plugin to get bundle information
--entry string[] The entry point(s) of your application.
-c, --config string[] Provide path to webpack configuration file(s)
--config-name string[] Name of the configuration to use
-m, --merge Merge several configurations using webpack-merge
--progress string, boolean Print compilation progress during build
--color Enables colors on console
--no-color Disable colors on console
--env string[] Environment passed to the configuration when it is a function
--name string Name of the configuration. Used when loading multiple configurations
--help Outputs list of supported flags
-o, --output-path string Output location of the generated bundle
-t, --target string[] Sets the build target
-w, --watch Watch for files changes
--no-watch Do not watch for file changes
-h, --hot Enables Hot Module Replacement
--no-hot Disables Hot Module Replacement
-d, --devtool string Controls if and how source maps are generated.
--no-devtool Do not generate source maps
--prefetch string Prefetch this request
-j, --json string, boolean Prints result as JSON or store it in a file
--mode string Defines the mode to pass to webpack
-v, --version Get current version
--stats string, boolean It instructs webpack on how to treat the stats
--no-stats Disables stats output
Checkout OPTIONS.md to see list of all available options.
FAQs
CLI for webpack & friends
The npm package webpack-cli receives a total of 5,776,682 weekly downloads. As such, webpack-cli popularity was classified as popular.
We found that webpack-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.