Design System Creator (ds-creator)

ds-creator is a CLI tool for creating a modern, production-ready Design System in seconds. It scaffolds a new project from a template package (default: tharaday) or a local template directory, so you can focus on building components instead of setting up tooling.

🌟 Features

• Template-driven: Uses a published package or local folder as the scaffold source.
• Design tokens: Can apply unit conversions (rem/em/px) to generated tokens.
• Fast start: Creates a ready-to-work project structure in seconds.

🚀 Quick Start

You can run ds-creator directly from any directory without installing it, using npx, or install it globally.

1. Run with npx

npx ds-creator my-design-system

If you omit the project name, the CLI will prompt you. It will create the project in your current directory.

2. Install globally (Optional)

npm install -g ds-creator
ds-creator my-design-system

Note: npx will download the package to a temporary folder. It does not install it permanently in your project or globally.

Options

• [project-name]: Output directory name.
• --force: Overwrite an existing directory.
• -h, --help: Show help info.

📦 What's Included?

The generated design system matches whatever your template provides (components, tooling, tokens, etc.). By default it uses the tharaday template.

🔧 Template Sources

By default, ds-creator comes with a bundled version of the tharaday template, allowing it to work out-of-the-box without extra downloads.

Template packages can define an allowlist in package.json:

{
  "dsCreator": {
    "include": ["package.json", "src", ".storybook"]
  }
}

When include is provided, only those paths are copied into the generated project.

📚 Documentation

• CLI usage: docs/CLI.md
• Contributing & local dev: docs/CONTRIBUTING.md
• Releases & automation: docs/RELEASES.md