@dofu-lab/simui-cli

A small, focused CLI to fetch and inject SimUI Angular components into an existing Angular project.

This tool fetches component source from the SimUI registry (https://simui.dev/registry), writes the component file into your project, and offers to install any detected dependencies (Spartan UI generators and ng-icons).

Features

• Fetch a component by name and inject it into your project
• Detects @spartan-ng/helm/* and @ng-icons/* imports and offers to install them
• Default output path: src/app/components (configurable with --path)

Prerequisites

• Node.js >= 18
• An Angular project (CLI available via ng)

Installation (local use)

You can run the CLI directly from the built artifact in this repository without publishing to npm:

cd packages/cli
npm install
npm run build
node dist/index.js add accordion-01

Usage

# Fetch and add a component to the default location
node dist/index.js add accordion-01

# Use the published package (once available)
npx @dofu-lab/simui-cli add accordion-01

# Override output directory
node dist/index.js add badge-01 --path src/shared/ui

Commands

• add <component> — fetches <component> from the registry and writes <component>.component.ts to the output directory.

Options

• -p, --path <dir> — Output directory relative to the current working directory (default: src/app/components).

What the command does

1. Fetches https://simui.dev/registry/<name>.json and reads the content field.
2. Writes the TypeScript component file to the chosen output path.
3. Parses the source for @spartan-ng/helm/* and @ng-icons/* imports.
4. Prompts to install dependencies. Spartan packages are invoked via the Angular generator:

ng generate @spartan-ng/cli:ui <package>

And @ng-icons/* packages are installed via your detected package manager (pnpm, yarn, or npm).

Development

cd packages/cli
npm install
npm run build
# Run the CLI locally
node dist/index.js add select-01

Publishing

Follow these steps to publish a new version of this package under the @dofu-lab scope.

cd packages/cli
# bump version (creates a commit + tag)
npm version patch

# build
npm run build

# dry-run
npm publish --dry-run

# publish (scoped public requires --access public)
npm publish --access public

# push commits and tags
git push origin main
git push --tags

Contributing

Contributions are welcome. Open issues or pull requests against this repository. For code changes:

1. Fork the repo
2. Create a feature branch
3. Run tests and build locally
4. Submit a pull request

License

This project is licensed under the MIT License — see the LICENSE file for details.

Support

If you encounter issues, open an issue on the repository with logs and reproduction steps.