@nikkory/vibe-cli 2.3.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +261 -138
  2. package/dist/index.js +2 -2
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,193 +1,307 @@
1
1
  # @nikkory/vibe-cli
2
2
 
3
- Command-line interface for Nikkory Vibe code generator.
3
+ **Production-ready code in seconds** - Generate enterprise-grade UI components, sections, and pages with the Nikkory Vibe CLI.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/@nikkory/vibe-cli.svg)](https://www.npmjs.com/package/@nikkory/vibe-cli)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
+
8
+ ## Features
9
+
10
+ - **169 Components** - Buttons, cards, inputs, modals, and more
11
+ - **50 Sections** - Hero sections, pricing tables, testimonials, features
12
+ - **12 Design Systems** - Material Design, iOS HIG, Glassmorphism, and more
13
+ - **3 Quality Tiers** - Basic (prototype), Standard (production), Enterprise (mission-critical)
14
+ - **Smart Generation** - 24-factor matrix system for infinite variations
15
+ - **Section Orchestrator** - Slot-based composition with automatic component generation
16
+ - **Page Builder** - Multi-section composition for complete pages
4
17
 
5
18
  ## Installation
6
19
 
7
20
  ```bash
8
- # Global installation
21
+ # npm
22
+ npm install -g @nikkory/vibe-cli
23
+
24
+ # pnpm
9
25
  pnpm add -g @nikkory/vibe-cli
10
26
 
11
- # Local installation
12
- pnpm add -D @nikkory/vibe-cli
27
+ # yarn
28
+ yarn global add @nikkory/vibe-cli
13
29
  ```
14
30
 
15
31
  ## Quick Start
16
32
 
17
33
  ```bash
18
34
  # Initialize new project
19
- vibe init my-app
35
+ nikkory-vibe init my-app
36
+
37
+ # Add a component
38
+ nikkory-vibe add button
20
39
 
21
- # Generate component
22
- vibe generate component MyButton --design material-design
40
+ # Add a section
41
+ nikkory-vibe add:section hero-centered
23
42
 
24
- # List available options
25
- vibe list
43
+ # Add a full page
44
+ nikkory-vibe add:page landing
45
+
46
+ # List available templates
47
+ nikkory-vibe list
26
48
  ```
27
49
 
28
50
  ## Commands
29
51
 
30
- ### `vibe init`
52
+ ### `nikkory-vibe add` (aliases: `gen`, `generate`)
31
53
 
32
- Initialize a new Nikkory Vibe project.
54
+ Generate UI components with the 24-factor Matrix system.
33
55
 
34
56
  ```bash
35
- vibe init my-app
36
- vibe init my-app --framework react --design material-design
37
- vibe init my-app --backend --no-install
57
+ # Basic usage
58
+ nikkory-vibe add button
59
+
60
+ # With design system and tier
61
+ nikkory-vibe add button -s ios-hig -t enterprise
62
+
63
+ # With custom output path
64
+ nikkory-vibe add card -o src/components/Card.tsx
65
+
66
+ # With factor overrides (advanced)
67
+ nikkory-vibe add button --factor-overrides '{"borderRadius":"rounded-full"}'
38
68
  ```
39
69
 
70
+ **Arguments:**
71
+ - `<component>` - Component ID (button, input, card, modal, etc.)
72
+
40
73
  **Options:**
41
- - `-f, --framework <framework>` - Frontend framework (react, vue, angular, svelte, solid)
42
- - `-d, --design <system>` - Default design system
43
- - `--backend` - Include backend (NestJS)
44
- - `--no-install` - Skip dependency installation
74
+ - `-s, --design-system <system>` - Design system (default: `material-design`)
75
+ - `-t, --tier <tier>` - Quality tier: basic, standard, enterprise (default: `standard`)
76
+ - `-f, --factor-overrides <json>` - Override specific design factors (JSON)
77
+ - `-o, --output <path>` - Output file path
78
+
79
+ **Available Components (169 total)**:
80
+ - **Forms**: button, input, textarea, checkbox, radio-group, switch, select, slider
81
+ - **Feedback**: alert, badge, chip, progress, spinner, skeleton, tooltip
82
+ - **Navigation**: tabs, menu, breadcrumb, pagination, stepper
83
+ - **Data Display**: card, table, list, accordion, avatar
84
+ - **Overlay**: modal, drawer, popover
85
+ - **Date/Time**: date-picker, calendar
86
+ - **Media**: audio, video, image, file
45
87
 
46
- ### `vibe generate` (alias: `g`)
88
+ ### `nikkory-vibe add:section` (alias: `section`)
47
89
 
48
- Generate components from templates.
90
+ Generate sections using the Section Orchestrator (composition-based).
49
91
 
50
92
  ```bash
51
93
  # Basic usage
52
- vibe generate component MyButton
94
+ nikkory-vibe add:section hero-centered
95
+
96
+ # With design system and tier
97
+ nikkory-vibe add:section pricing-cards -s material-design -t enterprise
98
+
99
+ # With custom output path
100
+ nikkory-vibe add:section testimonials-grid -o src/sections/Testimonials.tsx
101
+ ```
53
102
 
54
- # Specify design system and tier
55
- vibe generate component ActionButton --design ios-hig --tier enterprise
103
+ **Arguments:**
104
+ - `<section>` - Section ID (hero-centered, pricing-cards, etc.)
56
105
 
57
- # Interactive mode
58
- vibe generate --interactive
106
+ **Options:**
107
+ - `-s, --design-system <system>` - Design system (default: `material-design`)
108
+ - `-t, --tier <tier>` - Quality tier: basic, standard, enterprise (default: `standard`)
109
+ - `-o, --output <path>` - Output file path
59
110
 
60
- # Dry run (preview without writing)
61
- vibe generate component Card --dry-run
111
+ **Available Sections (50 total)**:
112
+ - **Hero** (10): hero-centered, hero-split, hero-video-background, hero-gradient
113
+ - **Features** (8): features-grid, features-alternating, features-tabs
114
+ - **Testimonials** (6): testimonials-grid, testimonials-carousel, testimonials-wall
115
+ - **Pricing** (5): pricing-cards, pricing-table, pricing-toggle
116
+ - **CTA** (4): cta-centered, cta-split, cta-banner, cta-newsletter
117
+ - **FAQ** (3): faq-accordion, faq-two-column, faq-categorized
118
+ - **Team** (3): team-grid, team-carousel, team-leadership
119
+ - **Contact** (3): contact-form, contact-split, contact-info
120
+ - **Gallery** (3): gallery-masonry, gallery-grid, gallery-slider
121
+ - **Stats** (5): stats-numbers, stats-visual, stats-comparison
62
122
 
63
- # Custom output path
64
- vibe generate component LoginForm --output src/features/auth/LoginForm.tsx
123
+ ### `nikkory-vibe add:page` (alias: `page`)
124
+
125
+ Generate full pages with multi-section composition.
126
+
127
+ ```bash
128
+ # Basic usage
129
+ nikkory-vibe add:page landing
130
+
131
+ # With design system and tier
132
+ nikkory-vibe add:page dashboard -s ios-hig -t enterprise
133
+
134
+ # With custom output path
135
+ nikkory-vibe add:page auth -o src/pages/AuthPage.tsx
65
136
  ```
66
137
 
67
138
  **Arguments:**
68
- - `[type]` - Type to generate (component, section, page) - default: component
139
+ - `<page>` - Page ID (landing, dashboard, auth, etc.)
69
140
 
70
141
  **Options:**
71
- - `-n, --name <name>` - Component name (PascalCase)
72
- - `-t, --template <template>` - Template type (button, card, input, etc.)
73
- - `-d, --design <system>` - Design system (default: material-design)
74
- - `--tier <tier>` - Quality tier (basic, standard, enterprise) - default: standard
75
- - `-f, --framework <framework>` - Framework (react, vue, etc.) - default: react
142
+ - `-s, --design-system <system>` - Design system (default: `material-design`)
143
+ - `-t, --tier <tier>` - Quality tier: basic, standard, enterprise (default: `standard`)
76
144
  - `-o, --output <path>` - Output file path
77
- - `--dry-run` - Preview generated code without writing
78
- - `--interactive` - Interactive mode with prompts
79
145
 
80
- ### `vibe list` (alias: `ls`)
146
+ **Page Types**:
147
+ - **Marketing**: landing, pricing, about
148
+ - **App**: dashboard, settings, profile
149
+ - **Auth**: login, signup, forgot-password
150
+ - **E-commerce**: product, cart, checkout
151
+
152
+ ### `nikkory-vibe list` (alias: `ls`)
81
153
 
82
- List available templates and design systems.
154
+ List available templates, design systems, and tiers.
83
155
 
84
156
  ```bash
85
157
  # List everything
86
- vibe list
158
+ nikkory-vibe list
87
159
 
88
160
  # List specific category
89
- vibe list templates
90
- vibe list designs
91
- vibe list tiers
92
- vibe list frameworks
161
+ nikkory-vibe list components
162
+ nikkory-vibe list sections
163
+ nikkory-vibe list design-systems
164
+ nikkory-vibe list tiers
93
165
 
94
166
  # JSON output
95
- vibe list --json
167
+ nikkory-vibe list --json
96
168
  ```
97
169
 
98
170
  **Arguments:**
99
- - `[category]` - Category to list (templates, designs, tiers, frameworks, all)
171
+ - `[category]` - Category to list (components, sections, design-systems, tiers, all)
100
172
 
101
173
  **Options:**
102
174
  - `--json` - Output as JSON
103
175
 
104
- ## Examples
176
+ ### `nikkory-vibe init`
105
177
 
106
- ### Generate Material Design Button
178
+ Initialize a new Nikkory Vibe project with AI Agent Inspector.
107
179
 
108
180
  ```bash
109
- vibe g component SubmitButton \
110
- --design material-design \
111
- --tier standard \
112
- --framework react
181
+ # Basic usage
182
+ nikkory-vibe init my-app
183
+
184
+ # With options
185
+ nikkory-vibe init my-app --framework react --design material-design
113
186
  ```
114
187
 
115
- ### Generate iOS-style Card (Enterprise)
188
+ **Arguments:**
189
+ - `[project-name]` - Project name (optional)
116
190
 
117
- ```bash
118
- vibe g component ProfileCard \
119
- --design ios-hig \
120
- --tier enterprise \
121
- --output src/components/ProfileCard.tsx
122
- ```
191
+ **Options:**
192
+ - `-f, --framework <framework>` - Frontend framework (react, vue, angular)
193
+ - `-d, --design <system>` - Default design system
194
+ - `--no-install` - Skip dependency installation
195
+
196
+ ## Design Systems (12 available)
197
+
198
+ | Design System | ID | Description |
199
+ | ---------------- | ---------------- | -------------------------------- |
200
+ | Material Design | `material-design`| Google's design language |
201
+ | iOS HIG | `ios-hig` | Apple Human Interface Guidelines |
202
+ | Glassmorphism | `glassmorphism` | Frosted glass effect |
203
+ | Neumorphism | `neumorphism` | Soft UI with shadows |
204
+ | Brutalism | `brutalism` | Bold, raw aesthetic |
205
+ | Minimalism | `minimalism` | Clean, simple design |
206
+ | Fluent | `fluent` | Microsoft Fluent Design |
207
+ | Carbon | `carbon` | IBM Carbon Design System |
208
+ | Ant Design | `ant-design` | Ant Design (Alibaba) |
209
+ | Chakra | `chakra` | Chakra UI style |
210
+ | Atlassian | `atlassian` | Atlassian Design System |
211
+ | Blueprint | `blueprint` | Palantir Blueprint |
212
+
213
+ ## Quality Tiers
214
+
215
+ | Tier | Purpose | Features | LOC |
216
+ | ---------- | ---------------- | ------------------------------------------- | ------- |
217
+ | Basic | Prototype, MVP | Core props, basic styling | 30-50 |
218
+ | Standard | Production apps | Multiple variants, sizes, forwardRef | 50-150 |
219
+ | Enterprise | Mission-critical | Analytics, memoization, accessibility, ARIA | 150-300 |
220
+
221
+ ## Examples
123
222
 
124
- ### Interactive Component Generation
223
+ ### Generate a Material Design Button (Standard Tier)
125
224
 
126
225
  ```bash
127
- vibe g --interactive
226
+ nikkory-vibe add button -s material-design -t standard
128
227
  ```
129
228
 
130
- This will prompt you for:
131
- - Component name
132
- - Template type
133
- - Design system
134
- - Quality tier
135
- - Framework
229
+ **Output**:
230
+ - Full React component with forwardRef, displayName
231
+ - Multiple variants (filled, outlined, text)
232
+ - Sizes (sm, md, lg)
233
+ - TypeScript types
234
+ - ~150 lines of code
136
235
 
137
- ### Preview Before Writing
236
+ ### Generate a Hero Section (Enterprise Tier)
138
237
 
139
238
  ```bash
140
- vibe g component Hero --design glassmorphism --dry-run
239
+ nikkory-vibe add:section hero-centered -s ios-hig -t enterprise
141
240
  ```
142
241
 
143
- ### Initialize Full-Stack Project
242
+ **Output**:
243
+ - Composed section with multiple components (heading, text, buttons, image)
244
+ - Analytics tracking
245
+ - ARIA attributes
246
+ - Memoized components
247
+ - ~400+ lines of code
248
+
249
+ ### Generate a Complete Landing Page
144
250
 
145
251
  ```bash
146
- vibe init my-saas-app \
147
- --framework react \
148
- --design material-design \
149
- --backend
252
+ nikkory-vibe add:page landing -s glassmorphism -t enterprise -o src/pages/Landing.tsx
150
253
  ```
151
254
 
152
- ## Available Options
153
-
154
- ### Templates
155
-
156
- - `button` - Interactive button components
157
- - `card` - Content container cards
158
- - `input` - Form input fields
159
- - `modal` - Dialog/modal overlays
160
- - `table` - Data tables
161
- - `form` - Form layouts
162
- - `navigation` - Nav bars and menus
163
- - `hero` - Hero sections
164
- - `feature` - Feature showcases
165
- - `pricing` - Pricing tables
255
+ **Output**:
256
+ - Multi-section composition (hero + features + pricing + testimonials + CTA)
257
+ - Consistent design system across all sections
258
+ - All components automatically generated
259
+ - ~1000+ lines of production-ready code
166
260
 
167
- ### Design Systems
261
+ ### Generate with Custom Factors
168
262
 
169
- - `material-design` - Material Design 3
170
- - `ios-hig` - iOS Human Interface Guidelines
171
- - `glassmorphism` - Frosted glass effect
172
- - `neumorphism` - Soft UI design
173
- - `minimalism` - Clean and simple
174
- - `brutalism` - Bold and raw
175
- - `cyberpunk` - Futuristic neon
176
- - `retro` - Vintage aesthetics
263
+ ```bash
264
+ nikkory-vibe add button --factor-overrides '{
265
+ "borderRadius": "rounded-full",
266
+ "shadowIntensity": "high",
267
+ "animation": "enabled"
268
+ }'
269
+ ```
177
270
 
178
- ### Quality Tiers
271
+ ## Architecture
179
272
 
180
- - `basic` - Prototype/demo quality (~60 LOC)
181
- - `standard` - Production-ready (~200 LOC)
182
- - `enterprise` - Mission-critical (~350 LOC)
273
+ ### 3-Level Generation System
183
274
 
184
- ### Frameworks
275
+ ```
276
+ Page (7 factors)
277
+ ↓ Factor Propagation
278
+ Section (13 factors)
279
+ ↓ Factor Propagation
280
+ Component (24 factors)
281
+ ```
185
282
 
186
- - `react` - React 18+ (.tsx)
187
- - `vue` - Vue 3+ (.vue)
188
- - `angular` - Angular 17+ (.component.ts)
189
- - `svelte` - Svelte 4+ (.svelte)
190
- - `solid` - Solid.js (.tsx)
283
+ **Component Level**: 24-factor matrix system
284
+ - Typography (4): font family, size, weight, line height
285
+ - Colors (3): primary, background, border
286
+ - Spacing (3): padding, margin, gap
287
+ - Effects (3): shadow, border radius, animation
288
+ - Layout (2): alignment, direction
289
+ - Interaction (3): hover, focus, active states
290
+ - Accessibility (2): ARIA, keyboard navigation
291
+ - Performance (2): lazy loading, memoization
292
+ - Analytics (2): tracking, events
293
+
294
+ **Section Level**: Slot-based composition
295
+ - Section factors (13) + inherited component factors (24)
296
+ - Automatic component generation for each slot
297
+ - CSS variable merging
298
+ - Layout wrapper generation
299
+
300
+ **Page Level**: Multi-section composition
301
+ - Page factors (7) + propagated section/component factors
302
+ - Parallel section generation
303
+ - Unified design system
304
+ - Complete page structure
191
305
 
192
306
  ## Configuration
193
307
 
@@ -197,54 +311,56 @@ Create `.viberc.json` in your project root:
197
311
  {
198
312
  "defaultDesignSystem": "material-design",
199
313
  "defaultTier": "standard",
200
- "defaultFramework": "react",
201
- "outputDir": "src/components",
202
- "fileExtension": "tsx"
314
+ "outputDir": "src/components"
203
315
  }
204
316
  ```
205
317
 
206
- ## Environment Variables
318
+ ## Statistics
207
319
 
208
- - `DEBUG=true` - Enable debug logging
209
- - `VIBE_OUTPUT_DIR` - Default output directory
320
+ - **169 Components** × 12 Design Systems × 3 Tiers = **6,084 variations**
321
+ - **50 Sections** × 12 Design Systems × 3 Tiers = **1,800 variations**
322
+ - **∞ Pages** (multi-section composition with infinite possibilities)
210
323
 
211
- ## Troubleshooting
324
+ ## CLI Shortcuts
212
325
 
213
- ### Template Not Found
326
+ You can use `vibe` as a shorter alias for `nikkory-vibe`:
214
327
 
215
328
  ```bash
216
- vibe list templates # Check available templates
217
- ```
329
+ # These are equivalent
330
+ nikkory-vibe add button
331
+ vibe add button
218
332
 
219
- ### Permission Denied
333
+ # Section generation
334
+ vibe add:section hero-centered
335
+ vibe section hero-centered
220
336
 
221
- ```bash
222
- # Run with appropriate permissions or change output directory
223
- vibe g component Button --output ./Button.tsx
337
+ # Page generation
338
+ vibe add:page landing
339
+ vibe page landing
224
340
  ```
225
341
 
226
- ### Import Errors
342
+ ## Integration
227
343
 
228
- Make sure your project has the required dependencies:
344
+ ### With React Projects
229
345
 
230
346
  ```bash
231
- pnpm add react react-dom
232
- pnpm add -D @types/react @types/react-dom
233
- ```
234
-
235
- ## CLI Output
347
+ # Install CLI
348
+ pnpm add -D @nikkory/vibe-cli
236
349
 
237
- The CLI provides rich, colorful output:
350
+ # Add to package.json scripts
351
+ {
352
+ "scripts": {
353
+ "vibe": "nikkory-vibe",
354
+ "vibe:add": "nikkory-vibe add",
355
+ "vibe:section": "nikkory-vibe add:section"
356
+ }
357
+ }
238
358
 
239
- - Green checkmarks for success
240
- - Red crosses for errors
241
- - ⚠ Yellow warnings
242
- - ℹ Blue info messages
243
- - Spinners for loading states
244
- - Boxed success messages
245
- - Formatted tables
359
+ # Use in your project
360
+ pnpm vibe add button -o src/components/Button.tsx
361
+ ```
246
362
 
247
- ## Integration with VSCode
363
+ ### With VSCode
248
364
 
249
365
  Install the Nikkory Vibe VSCode extension for:
250
366
  - Command palette integration
@@ -252,10 +368,17 @@ Install the Nikkory Vibe VSCode extension for:
252
368
  - Template preview
253
369
  - Syntax highlighting
254
370
 
371
+ ## Support
372
+
373
+ - **Website**: https://nikkory.com
374
+ - **Issues**: [GitHub Issues](https://github.com/kemonra/nikkory-vibe/issues)
375
+ - **Documentation**: [Full Docs](https://nikkory.com/docs)
376
+
255
377
  ## License
256
378
 
257
379
  MIT
258
380
 
259
381
  ---
260
382
 
261
- Powered by Nikkory
383
+ **Powered by Nikkory**
384
+ https://nikkory.com
package/dist/index.js CHANGED
@@ -1584,7 +1584,7 @@ ${y.bold(" \u255A\u2588\u2588\u2557 \u2588\u2588\u2554\u255D\u2588\u
1584
1584
  ${y.bold(" \u255A\u2588\u2588\u2588\u2588\u2554\u255D \u2588\u2588\u2551\u2588\u2588\u2588\u2588\u2588\u2588\u2554\u255D\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2557 ")}
1585
1585
  ${y.bold(" \u255A\u2550\u2550\u2550\u255D \u255A\u2550\u255D\u255A\u2550\u2550\u2550\u2550\u2550\u255D \u255A\u2550\u2550\u2550\u2550\u2550\u2550\u255D ")}
1586
1586
 
1587
- ${y(" happy together")} ${import_chalk5.default.white("\u2022 v2.3.0")}
1587
+ ${y(" happy together")} ${import_chalk5.default.white("\u2022 v2.3.1")}
1588
1588
 
1589
1589
  ${import_chalk5.default.gray(" Production-ready code in seconds")}
1590
1590
  ${import_chalk5.default.gray(" https://nikkory.com")}
@@ -1592,7 +1592,7 @@ ${import_chalk5.default.gray(" https://nikkory.com")}
1592
1592
  ${y(` ${componentCount} Components`)} ${import_chalk5.default.gray("+")} ${y(`${sectionCount} Sections`)} ${import_chalk5.default.gray("\xD7")} ${y(`${designSystemCount} Systems`)} ${import_chalk5.default.gray("\xD7")} ${y(`${tierCount} Tiers`)}
1593
1593
  `;
1594
1594
  var program = new import_commander6.Command();
1595
- program.name("nikkory-vibe").description("Nikkory Vibe - Production-ready code in seconds").version("2.3.0").addHelpText("before", banner);
1595
+ program.name("nikkory-vibe").description("Nikkory Vibe - Production-ready code in seconds").version("2.3.1").addHelpText("before", banner);
1596
1596
  program.addCommand(matrixGenerateCommand);
1597
1597
  program.addCommand(sectionGenerateCommand);
1598
1598
  program.addCommand(pageGenerateCommand);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nikkory/vibe-cli",
3
- "version": "2.3.0",
3
+ "version": "2.3.1",
4
4
  "description": "CLI tool for Nikkory Vibe - Generate production-ready code in seconds",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",