ChampCSS Vanilla CLI

The official CLI for ChampCSS Vanilla. Scaffold a new ChampCSS project in seconds, directly in your terminal.

Requirements

• Node.js 18 or later

Quick start

npx champ-css my-project

or

npm create champ-css my-project

Both commands fetch the latest ChampCSS template directly from GitHub and drop it into my-project.

Usage

npx champ-css [directory] [options]

If you don't pass a directory, you'll be prompted for one interactively.

Options

| Flag | Description | | --- | --- | | -f, --force | Overwrite the target directory if it already has files in it | | update| Grabs the latest version of the ChampCSS library. this will override any core files you have edited*

Examples

# Scaffold into a new folder named "my-site"
npx champ-css my-site

# Scaffold into the current directory
npx champ-css .

# Overwrite an existing directory
npx champ-css my-site --force

# Use npm's create shorthand (note the -- before flags)
npm create champ-css my-site -- --force

# update the framework 
npx champ-css update 

How it Works

This CLI doesn't bundle any framework files itself. Every time you run it, it fetches the latest version of the ChampCSS template directly from GitHub, so you always get the newest version of the framework — no need to update this CLI when the framework changes.

When you need to update your copy of ChampCSS, run npx champ-css update. What this does is grab the latest version of the ChampCSS library, and rip it to your working directory. *When you run it, it will override any core framework content.

Core files:

{
  "overwritable": [
    "css/reset.css",
    "css/utils",
    "css/plugins"
  ]
}

Links

• ChampCSS website
• ChampCSS template repo
• Report an issue

License

ISC