kawarem-dashboard CLI

CLI toolkit for bootstrapping a Kawarem dashboard and dropping in prebuilt blocks (UI, shared components, layouts, hooks, utils, schemas, and pages) from the bundled registry. Ships a Vite + React + TypeScript + Tailwind starter so you can go from zero to running dashboard quickly.

Prerequisites

• Node.js 18+ (20+ recommended)
• npm, pnpm, or yarn (auto-detected when installing deps)

Quick start: scaffold a project

1. Create the project (empty folder required):

npx kawarem-dashboard init my-dashboard

2. Move into the project, install, and start dev:

cd my-dashboard
npm install
npm run dev

init copies the template into the target folder, renames gitignore -> .gitignore, sets the package name, writes kawarem-dashboard.json with expected paths, and adds a kawaremDashboard.initialized flag to package.json.

Add components/blocks

• See what is available:

kawarem-dashboard list

• Add one or more blocks (required blocks are auto-added first):

kawarem-dashboard add login-page          # also installs login-form, login-schema
kawarem-dashboard add ui-all              # installs the full UI kit
kawarem-dashboard add badge table dialog  # add multiple at once

What happens when you run add:

• Fails early if the project is not initialized via kawarem-dashboard.json or the package marker.
• Checks for the @/* path alias in tsconfig.json/jsconfig.json and warns if missing.
• Copies each block's files from registry/files/* into the target paths (for example src/components/ui, src/components/shared, src/layout, src/hooks, src/utils, src/schema, src/base, src/pages).
• Prompts before overwriting existing files; skips files marked skipIfExists.
• Collects npm dependencies declared by each block and installs them using your detected package manager.

Commands

• kawarem-dashboard --help or no args: show command help.
• kawarem-dashboard init [dir]: scaffold a new project in dir (prompts if omitted). Requires empty folder.
• kawarem-dashboard list: list all registry blocks with their types.
• kawarem-dashboard add <name...>: add one or more registry blocks, including their requires chain and npm dependencies.
• kawarem-dashboard validate: sanity-check the registry files, command exports, and the project's @/* alias configuration.

Registry at a glance

• UI: alert-dialog, badge, calendar, chart, dialog, dropdown-menu, input, label, popover, select, switch, table, textarea, ui-all (aggregated UI kit).
• Shared: actions-menu, chart-bar-active, chart-pie-donut, custom-calendar, custom-image, delete-alert, dialog-component, field, field-file, field-select, get-status-badge, image-file-input, logo, pagination, search-input, section-title.
• Layout/Base/Page/Schema/Other: auth-page-shell, dashboard-layout, details-container, header, header-label, sidebar, sidebar-dropdown, sidebar-link, login-page, login-form, login-schema, header-items, sidebar-items, use-header-store, find-label-by-href.

Notes

• The template is Vite + React + TypeScript + Tailwind with @/* path alias enabled out of the box.
• If you use an existing project, ensure an @/* alias exists and add a kawarem-dashboard.json marker (or set kawaremDashboard.initialized in package.json) so add can run.