@ngcorex/cli

Command-line interface for ngCorex.

This package provides the ngcorex CLI used to build CSS from an ngcorex.config.ts file using the ngCorex engine.

It is intended to be installed as a development dependency in projects that use ngCorex.

What This CLI Does

The ngCorex CLI:

• loads ngcorex.config.ts
• validates design tokens
• applies constraints
• generates CSS variables
• writes the output CSS file
• supports watch mode and dry runs

All work happens at build time.

Getting Started

Installation

Install the CLI as a dev dependency:

npm install -D @ngcorex/cli

The CLI depends on @ngcorex/css, which will be installed automatically.

Create tokens.json

Create a tokens.json file at your project root:

{
  "spacing": {
    "1": "1rem",
    "2": "2rem"
  },
  "colors": {
    "gray": {
      "100": "#f3f4f6",
      "900": "#111827"
    }
  }
}

If tokens.json is present, it is used automatically.

Configuration File

The CLI expects a file named:

Create ngcorex.config.ts

Create a ngcorex.config.ts file at your project root:

import { defineNgCorexConfig } from '@ngcorex/css';

export default defineNgCorexConfig({
  output: {
    file: 'src/styles/ngcorex.css'
  }
});

Important Rules

• The config file must import from npm packages only
• Relative imports are not allowed
• The config is transpiled internally using esbuild

Commands

Build CSS

npx ngcorex build

• Loads ngcorex.config.ts
• Generates CSS output
• Writes the output file

Watch Mode

npx ngcorex build --watch

• Watches ngcorex.config.ts
• Rebuilds on change
• Does not exit on errors

Dry Run

npx ngcorex build --dry-run

• Runs the full pipeline
• Does NOT write any files
• Useful for testing configuration

Version

npx ngcorex version

Prints the CLI version.

Output

The CLI generates CSS variables based on your tokens and constraints.

Example output:

:root {
  --nx-spacing-1: 1rem;
  --nx-spacing-2: 2rem;
  --nx-color-gray-100: #f3f4f6;
  --nx-color-gray-900: #111827;
}

License

MIT