CLI
PurgeCSS is available via a Command Line Interface. You can use the CLI by itself or with a configuration file.
Installation
You can either install PurgeCSS as a dev dependency and use the CLI with npx
or you can also install PurgeCSS globally:
npm i -g purgecss
Usage
To see the available options for the CLI: purgecss --help
Usage: purgecss --css <css...> --content <content...> [options]
Remove unused css selectors
Options:
-V, --version output the version number
-con, --content <files...> glob of content files
-css, --css <files...> glob of css files
-c, --config <path> path to the configuration file
-o, --output <path> file path directory to write purged css files to
-font, --font-face option to remove unused font-faces
-keyframes, --keyframes option to remove unused keyframes
-v, --variables option to remove unused variables
-rejected, --rejected option to output rejected selectors
-rejected-css, --rejected-css option to output rejected css
-s, --safelist <list...> list of classes that should not be removed
-b, --blocklist <list...> list of selectors that should be removed
-k, --skippedContentGlobs <list...> list of glob patterns for folders/files that should not be scanned
-h, --help display help for command
The options available through the CLI are similar to the ones available with a configuration file. You can also use the CLI with a configuration file.
--css
purgecss --css css/app.css css/palette.css --content src/index.html
--content
You can specify content that should be analyzed by PurgeCSS with an array of filenames or globs. These files can be HTML, Pug, Blade, etc.
purgecss --css css/app.css --content src/index.html src/**/*.js
--config
You can use the CLI with a configuration file. Use --config
or -c
with the path to the config file.
purgecss --config ./purgecss.config.js
--output
By default, the CLI outputs the result in the console. If you wish to return the CSS as files, specify the directory to write the purified CSS files to.
purgecss --css css/app.css --content src/index.html "src/**/*.js" --output build/css/
--safelist
If you wish to prevent PurgeCSS from removing a specific CSS selector, you can add it to the safelist.
purgecss --css css/app.css --content src/index.html --safelist classnameToSafelist