CLI Reference
Scaffold full Next.js projects and add individual components with one command.
How it works
Run the command
No global install needed. npx downloads the latest CLI from npm automatically.
npx kaeyros-ui@latest initPick a template
The interactive prompt shows all 9 templates. Select one or pass --template flag.
? Which template? › ...Start coding
The CLI copies template files, installs dependencies, and you're ready to go.
cd my-app && npm run devOui — quand le package est publié sur npm, tout est en ligne
Lorsque kaeyros-ui est publié sur npm avec npm publish, quand quelqu'un tape npx kaeyros-ui@latest, npm télécharge automatiquement la dernière version du package — CLI, templates, et composants inclus. Les fichiers dist/ et templates/ sont bundlés dans le package npm.
cd packages/clinpm loginnpm publish --access publicCommands
npx kaeyros-ui@latest initinitScaffold a complete Next.js project from a template.
Options
-t, --template <slug>Template slug (e.g. dashboard-analytics)-n, --name <name>Project name / folder-d, --dir <path>Target directory (default: current dir)Examples
npx kaeyros-ui@latest initnpx kaeyros-ui@latest init --template oim-platform --name my-appnpx kaeyros-ui@latest init -t admin-crm -n crm-app -d ./appsnpx kaeyros-ui@latest addaddAdd individual UI components to an existing project.
Options
[component]Component name (optional — shows interactive picker if omitted)Examples
npx kaeyros-ui@latest addnpx kaeyros-ui@latest add kpi-cardnpx kaeyros-ui@latest add opportunity-cardnpx kaeyros-ui@latest add step-wizardnpx kaeyros-ui@latest listlistList all available templates with descriptions and tags.
Options
-s, --search <query>Filter templates by name, description, or tagExamples
npx kaeyros-ui@latest listnpx kaeyros-ui@latest list --search dashboardnpx kaeyros-ui@latest lsAll Templates
9 templatesDashboard Analytics
Dashboard · 4 pages
--template dashboard-analyticsBooking System
Application · 7 pages
--template booking-systemAdmin Panel
Dashboard · 8 pages
--template admin-panelSaaS Platform
Application · 9 pages
--template saas-platformRestaurant POS
Application · 7 pages
--template restaurant-posMarketplace
Application · 9 pages
--template marketplaceOIM Platform
Application · 8 pages
--template oim-platformAnalytics Map Dashboard
Dashboard · 7 pages
--template analytics-map-dashboardAdmin CRM
Dashboard · 10 pages
--template admin-crmAll Components
34 componentsnpx kaeyros-ui@latest add [component-name]floating-input
Formsmulti-select
Formsimage-uploader
Formsstep-wizard
Formsresponsive-table
Data Displaydata-detail-card
Data Displaystat-card-decorated
Dashboardquick-action-card
Dashboardkpi-card
Dashboardgeneric-widget
Dashboardappointment-card
Bookingtime-slot-picker
Bookingavailability-grid
Bookingchat-message-bubble
Chatchat-input-advanced
Chatconversation-list
Chatorder-card
Commercepos-terminal
Commercedelivery-tracker
Commerceopportunity-card
Marketplacefilter-sidebar
Marketplaceannouncement-card
Marketplaceservice-card
Marketplacelightbox
Mediaphoto-gallery
Mediahero-section
Landingprofile-card
Profileonboarding-flow
Profileauth-layout
Authnotification-dropdown
Navigationcollapsible-sidebar
Navigationrole-switcher
Navigationconfirmation-modal
Overlaysprogress-banner
FeedbackPublish to npm
Once published on npm, anyone in the world can scaffold your templates with a single npx command. No global installation required — npm handles the download automatically.
cd ui-library-creation/packages/clinpm run buildnpm loginnpm publish --access publicWhat's bundled in the npm package
dist/Compiled CLI (ESM, ~38 KB)
templates/9 complete project templates
templates/*/src/Full app source code per template
Package name: kaeyros-ui
Défini dans packages/cli/package.json. Le champ "bin" pointe vers ./dist/index.js, ce qui active la commande npx kaeyros-ui.