Unocss-cli NPM

unocss-cli

The missing CLI for the instant on-demand Atomic CSS engine. Perfect fit for your traditional backends.

Make sure to check out the UnoCSS repository for all the details.

Key Features

🍱 Suited for traditional backends like Laravel or Kirby
👀 Watch mode included
🔌 Supports custom configurations via unocss.config.js

Requirements

Node 14+ (Node 16 recommended)

Installation

If you want to use unocss-cli right away, simply call it with npx:

npx unocss-cli "site/{snippets,templates}/**/*.php"

Or install it with a package manager of your choice:

npm i unocss-cli -D # or pnpm i unocss-cli -D

Example package configuration:

ℹ️ 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": "^0.3.0"
  }
}

Global installation is supported as well, but not recommended.

Usage

You can also pass multiple glob patterns to unocss-cli:

npx unocss-cli "site/snippets/**/*.php" "site/templates/**/*.php"

Development

Add the --watch (or -w) flag to enable watching for file changes:

npx unocss-cli "site/{snippets,templates}/**/*.php" --watch

Production

npx unocss-cli "site/{snippets,templates}/**/*.php"

The final uno.css will be generated to the current directory by default.

Built-in Features

`unocss.config.js` Support

Create a unocss.config.js configuration file the root-level of your project to customize UnoCSS.

import { defineConfig } from 'unocss'

export default defineConfig({
  shortcuts: [
    { 'box': 'max-w-7xl mx-auto bg-gray-100 rounded-md shadow-sm p-4' }
  ]
})

For a list of options, head over to the UnoCSS configurations docs.