SearchCtrlK
Main Navigation - v66.8.1
| [ Web Proxy ] |
| Viewing: https://unocss.dev/integrations/cli | [Back] [Original] |
The command line interface for UnoCSS: @unocss/cli.
uno.config.tsThis package is shipped with the unocss package:
pnpm add -D unocssyarn add -D unocssnpm install -D unocssbun add -D unocssYou can also install the standalone package:
pnpm add -D @unocss/cliyarn add -D @unocss/clinpm install -D @unocss/clibun add -D @unocss/cliINFO
If you are not able to find the binary (e.g. with pnpm and only unocss is installed), you'll need to explicit install @unocss/cli standalone package.
You can also pass multiple glob patterns to @unocss/cli:
unocss "site/snippets/**/*.php" "site/templates/**/*.php"Example package configuration:
INFO
Make sure to add escaped quotes to your npm script glob patterns.
{
"scripts": {
"dev": "unocss \"site/{snippets,templates}/**/*.php\" --watch",
"build": "unocss \"site/{snippets,templates}/**/*.php\""
},
"devDependencies": {
"@unocss/cli": "latest"
}
}Add the --watch (or -w) flag to enable watching for file changes:
unocss "site/{snippets,templates}/**/*.php" --watchunocss "site/{snippets,templates}/**/*.php"The final uno.css will be generated to the current directory by default.
Create a uno.config.js or uno.config.ts configuration file the root-level of your project to customize UnoCSS.
TIP
To achieve more granular configuration management, we recommend using a configuration file. It also supports different levels of packaging and rewriting for scanned files.
import { defineConfig } from 'unocss'
export default defineConfig({
cli: {
entry: {}, // CliEntryItem | CliEntryItem[]
},
// ...
})
interface CliEntryItem {
/**
* Glob patterns to match files
*/
patterns: string[]
/**
* The output filename for the generated UnoCSS file
*/
outFile: string
/**
* Whether to rewrite the transformed utilities.
*
* - For css: if rewrite is true, it will not generate a new file, but directly modify the original file content.
* - For other files: if rewrite is true, it replaces the original file with the transformed content.
*
* @default false
*/
rewrite?: boolean
/**
* Whether to output CSS files scanned from patterns to outFile
*
* - false: Do not output CSS files
* - true: Transform and output scanned CSS file contents to outFile
* - 'multi': Output each CSS file separately with filename format `${originFile}-[hash]`
* - 'single': Merge multiple CSS files into one output file named `outFile-merged.css`
*
* @default true
*/
splitCss?: boolean | 'multi' | 'single'
}Use the --rewrite flag to update your source files with transformed utilities. This is useful when you want to apply transformers (like Variant Groups or Compile Class) directly to your code.
unocss "src/**/*.vue" --rewriteWhen CSS files are included in the defined patterns, use the --split-css flag to control the output of CSS.
${originFile}-[hash]outFile-merged.cssunocss "src/**/*.vue" --split-css true|false|multi|singleIf no uno.config.ts file is found, the CLI will use a default preset. You can specify which version of the default preset to use with the --preset flag.
wind4: Use the preset-wind4.wind3: Use the preset-wind3.unocss "src/**/*.vue" --preset wind3|wind4Note: This option is ignored if a configuration file is present.
WARNING
Starting from version v66.6.0, @unocss/cli no longer provides a default preset. Users need to explicitly specify the --preset option or configure the preset in the configuration file.
For a list of options, head over to the UnoCSS configurations docs.
| Options | |
|---|---|
-v, --version | Display the current version of UnoCSS |
-c, --config [file] | Config file |
-o, --out-file <file> | The output filename for the generated UnoCSS file. Defaults to uno.css in the current working directory |
--stdout | Write the generated UnoCSS file to STDOUT. Will cause the --watch and --out-file being ignored |
-w, --watch | Indicates if the files found by the glob pattern should be watched |
--preflights | Enable preflight styles |
--rewrite | Update source files with transformed utilities |
--write-transformed | Update source files with transformed utilities (deprecated, use --rewrite) |
-m, --minify | Minify generated CSS |
--debug | Enable debug mode |
--split-css [mode] | Whether to output CSS files scanned from patterns to outFile. Options: true, false, multi, single |
--preset [default-preset] | Switch wind3 or wind4 preset as default. If you have configured uno.config, this option will be ignored. |
-h, --help | Display available CLI options |
Last updated:
Released under the MIT License.
Copyright 2021-PRESENT Anthony Fu
| Web Proxy Viewer | New URL | Original Page |