create-kuika-widget

Scaffold Kuika Widget projects with a single command.

Usage

# Interactive mode
npx create-kuika-widget@latest

# With project name
npx create-kuika-widget@latest "My Widgets"

Interactive Prompts

The CLI will guide you through the setup:

1. Widget Pack Name - Display name for your widget collection
2. Company - Your company or personal identifier (used in widget ID)
3. Framework - Choose your preferred framework
4. Stylesheet - Choose your styling approach
5. Package Manager - Choose your package manager
6. Git - Optionally initialize a git repository

Supported Options

Frameworks

| Framework | Version | | --------- | ------- | | React | ^19.0.0 | | Vue | ^3.4.0 | | Svelte | ^5.0.0 | | Angular | ^21.0.0 | | AngularJS | ^1.8.3 |

Stylesheets

• CSS
• SCSS
• Tailwind CSS

Package Managers

• yarn (recommended)
• npm
• pnpm
• bun

Example

$ npx create-kuika-widget@latest

🚀 Create Kuika Widget

? Widget Pack Name: My Dashboard Widgets
? Company: acme
  Widget ID: com.acme.my-dashboard-widgets

? Select a framework: React
? Select a stylesheet: Tailwind
? Select a package manager: yarn
? Initialize a git repository? Yes

Creating a new Kuika Widget project...

✔ Installing dependencies
✔ Initializing git repository

Project created successfully!

Next steps:
  cd my-dashboard-widgets
  yarn dev

Generated Project Structure

my-dashboard-widgets/
├── src/
│   ├── Components/       # Your widget components
│   ├── App.tsx           # Local playground
│   └── index.tsx         # Entry point
├── kuika.manifest.ts     # Widget configuration
├── package.json
├── tsconfig.json
└── README.md

Requirements

• Node.js >= 16.0.0