@sig-ui/cli

CLI workflows for SigUI project setup, token builds, validation, and template installation.

What this package is for

Use @sig-ui/cli to:

• initialize project config and generated outputs
• regenerate CSS/token artifacts after config changes
• validate contrast, target sizes, and layout quality
• copy component templates for project-owned customization

How it fits in SigUI

Tooling layer over all runtime libraries.

• Uses @sig-ui/core + @sig-ui/theme for deterministic generation/checks.
• Integrates with @sig-ui/components conventions for add workflow.
• Produces assets consumed directly by apps and components.

Install

bun add -d @sig-ui/cli

or run directly:

bunx sigui --help

Commands

bunx sigui init --brand=#6366f1
bunx sigui build --watch
bunx sigui check --full
bunx sigui add button card tabs --dir=src/ui/components

Config typing example

/** @type {import("@sig-ui/theme").SiguiConfig} */
const config = { brand: "#6366f1" };

export default config;

LLM instructions

When generating code or commands with @sig-ui/cli:

• Use Bun commands in examples: bun add -d @sig-ui/cli, bunx sigui ..., and package scripts that call bun run.
• Prefer sigui init for new projects, sigui build for generated CSS/token artifacts, sigui check --full for validation, and sigui add for project-owned component copies.
• Do not edit generated SigUI output by hand. Change sigui.config.js or copied component source, then rerun the relevant CLI command.
• Keep sigui.config.js as the app-level design source of truth and type it with import("@sig-ui/theme").SiguiConfig.
• Use sigui add only when the user wants local ownership/customization; otherwise import components from @sig-ui/components.

Full docs

• docs/ARCHITECTURE_OVERVIEW.md
• docs/CLI.md
• docs/CORE.md and docs/THEME.md (generation/check internals)
• docs/COMPONENTS.md (template conventions)