@nikkory/vibe-cli 2.3.1 → 2.3.2
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.
- package/README.md +140 -147
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,13 +7,12 @@
|
|
|
7
7
|
|
|
8
8
|
## Features
|
|
9
9
|
|
|
10
|
-
- **169 Components** - Buttons, cards, inputs, modals, and more
|
|
11
|
-
- **50 Sections** - Hero sections, pricing tables, testimonials,
|
|
12
|
-
- **
|
|
13
|
-
- **
|
|
14
|
-
- **
|
|
15
|
-
- **
|
|
16
|
-
- **Page Builder** - Multi-section composition for complete pages
|
|
10
|
+
- **169+ Components** - Buttons, cards, inputs, modals, tables, forms, and more
|
|
11
|
+
- **50+ Sections** - Hero sections, pricing tables, testimonials, feature showcases
|
|
12
|
+
- **Full Pages** - Complete landing pages, dashboards, auth flows
|
|
13
|
+
- **12 Design Systems** - Material Design, iOS HIG, Glassmorphism, Neumorphism, and more
|
|
14
|
+
- **3 Quality Tiers** - From rapid prototypes to mission-critical production code
|
|
15
|
+
- **Smart Generation** - Infinite variations with intelligent defaults
|
|
17
16
|
|
|
18
17
|
## Installation
|
|
19
18
|
|
|
@@ -43,7 +42,7 @@ nikkory-vibe add:section hero-centered
|
|
|
43
42
|
# Add a full page
|
|
44
43
|
nikkory-vibe add:page landing
|
|
45
44
|
|
|
46
|
-
# List available
|
|
45
|
+
# List available options
|
|
47
46
|
nikkory-vibe list
|
|
48
47
|
```
|
|
49
48
|
|
|
@@ -51,113 +50,89 @@ nikkory-vibe list
|
|
|
51
50
|
|
|
52
51
|
### `nikkory-vibe add` (aliases: `gen`, `generate`)
|
|
53
52
|
|
|
54
|
-
Generate UI components
|
|
53
|
+
Generate UI components instantly.
|
|
55
54
|
|
|
56
55
|
```bash
|
|
57
56
|
# Basic usage
|
|
58
57
|
nikkory-vibe add button
|
|
59
58
|
|
|
60
|
-
#
|
|
61
|
-
nikkory-vibe add button -s ios-hig
|
|
59
|
+
# Specify design system
|
|
60
|
+
nikkory-vibe add button -s ios-hig
|
|
62
61
|
|
|
63
|
-
#
|
|
62
|
+
# Choose quality tier
|
|
63
|
+
nikkory-vibe add button -t enterprise
|
|
64
|
+
|
|
65
|
+
# Custom output path
|
|
64
66
|
nikkory-vibe add card -o src/components/Card.tsx
|
|
65
67
|
|
|
66
|
-
#
|
|
68
|
+
# Advanced customization
|
|
67
69
|
nikkory-vibe add button --factor-overrides '{"borderRadius":"rounded-full"}'
|
|
68
70
|
```
|
|
69
71
|
|
|
70
72
|
**Arguments:**
|
|
71
|
-
- `<component>` - Component
|
|
73
|
+
- `<component>` - Component type (button, input, card, modal, etc.)
|
|
72
74
|
|
|
73
75
|
**Options:**
|
|
74
76
|
- `-s, --design-system <system>` - Design system (default: `material-design`)
|
|
75
77
|
- `-t, --tier <tier>` - Quality tier: basic, standard, enterprise (default: `standard`)
|
|
76
|
-
- `-f, --factor-overrides <json>` -
|
|
78
|
+
- `-f, --factor-overrides <json>` - Advanced customization (JSON)
|
|
77
79
|
- `-o, --output <path>` - Output file path
|
|
78
80
|
|
|
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
|
|
87
|
-
|
|
88
81
|
### `nikkory-vibe add:section` (alias: `section`)
|
|
89
82
|
|
|
90
|
-
Generate sections
|
|
83
|
+
Generate complete sections with multiple components.
|
|
91
84
|
|
|
92
85
|
```bash
|
|
93
|
-
#
|
|
86
|
+
# Generate hero section
|
|
94
87
|
nikkory-vibe add:section hero-centered
|
|
95
88
|
|
|
96
|
-
#
|
|
89
|
+
# Generate pricing section
|
|
97
90
|
nikkory-vibe add:section pricing-cards -s material-design -t enterprise
|
|
98
91
|
|
|
99
|
-
#
|
|
92
|
+
# Custom output
|
|
100
93
|
nikkory-vibe add:section testimonials-grid -o src/sections/Testimonials.tsx
|
|
101
94
|
```
|
|
102
95
|
|
|
103
96
|
**Arguments:**
|
|
104
|
-
- `<section>` - Section
|
|
97
|
+
- `<section>` - Section type (hero-centered, pricing-cards, features-grid, etc.)
|
|
105
98
|
|
|
106
99
|
**Options:**
|
|
107
100
|
- `-s, --design-system <system>` - Design system (default: `material-design`)
|
|
108
101
|
- `-t, --tier <tier>` - Quality tier: basic, standard, enterprise (default: `standard`)
|
|
109
102
|
- `-o, --output <path>` - Output file path
|
|
110
103
|
|
|
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
|
|
122
|
-
|
|
123
104
|
### `nikkory-vibe add:page` (alias: `page`)
|
|
124
105
|
|
|
125
|
-
Generate
|
|
106
|
+
Generate complete pages with multiple sections.
|
|
126
107
|
|
|
127
108
|
```bash
|
|
128
|
-
#
|
|
109
|
+
# Generate landing page
|
|
129
110
|
nikkory-vibe add:page landing
|
|
130
111
|
|
|
131
|
-
#
|
|
112
|
+
# Generate dashboard
|
|
132
113
|
nikkory-vibe add:page dashboard -s ios-hig -t enterprise
|
|
133
114
|
|
|
134
|
-
#
|
|
115
|
+
# Custom output
|
|
135
116
|
nikkory-vibe add:page auth -o src/pages/AuthPage.tsx
|
|
136
117
|
```
|
|
137
118
|
|
|
138
119
|
**Arguments:**
|
|
139
|
-
- `<page>` - Page
|
|
120
|
+
- `<page>` - Page type (landing, dashboard, auth, pricing, etc.)
|
|
140
121
|
|
|
141
122
|
**Options:**
|
|
142
123
|
- `-s, --design-system <system>` - Design system (default: `material-design`)
|
|
143
124
|
- `-t, --tier <tier>` - Quality tier: basic, standard, enterprise (default: `standard`)
|
|
144
125
|
- `-o, --output <path>` - Output file path
|
|
145
126
|
|
|
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
127
|
### `nikkory-vibe list` (alias: `ls`)
|
|
153
128
|
|
|
154
|
-
|
|
129
|
+
Browse available templates and options.
|
|
155
130
|
|
|
156
131
|
```bash
|
|
157
132
|
# List everything
|
|
158
133
|
nikkory-vibe list
|
|
159
134
|
|
|
160
|
-
# List
|
|
135
|
+
# List by category
|
|
161
136
|
nikkory-vibe list components
|
|
162
137
|
nikkory-vibe list sections
|
|
163
138
|
nikkory-vibe list design-systems
|
|
@@ -175,14 +150,17 @@ nikkory-vibe list --json
|
|
|
175
150
|
|
|
176
151
|
### `nikkory-vibe init`
|
|
177
152
|
|
|
178
|
-
Initialize a new
|
|
153
|
+
Initialize a new project.
|
|
179
154
|
|
|
180
155
|
```bash
|
|
181
156
|
# Basic usage
|
|
182
157
|
nikkory-vibe init my-app
|
|
183
158
|
|
|
184
|
-
# With
|
|
185
|
-
nikkory-vibe init my-app --framework react
|
|
159
|
+
# With framework
|
|
160
|
+
nikkory-vibe init my-app --framework react
|
|
161
|
+
|
|
162
|
+
# Skip installation
|
|
163
|
+
nikkory-vibe init my-app --no-install
|
|
186
164
|
```
|
|
187
165
|
|
|
188
166
|
**Arguments:**
|
|
@@ -193,7 +171,7 @@ nikkory-vibe init my-app --framework react --design material-design
|
|
|
193
171
|
- `-d, --design <system>` - Default design system
|
|
194
172
|
- `--no-install` - Skip dependency installation
|
|
195
173
|
|
|
196
|
-
## Design Systems
|
|
174
|
+
## Design Systems
|
|
197
175
|
|
|
198
176
|
| Design System | ID | Description |
|
|
199
177
|
| ---------------- | ---------------- | -------------------------------- |
|
|
@@ -212,133 +190,101 @@ nikkory-vibe init my-app --framework react --design material-design
|
|
|
212
190
|
|
|
213
191
|
## Quality Tiers
|
|
214
192
|
|
|
215
|
-
| Tier | Purpose |
|
|
216
|
-
| ---------- | ---------------- |
|
|
217
|
-
| Basic | Prototype, MVP |
|
|
218
|
-
| Standard | Production
|
|
219
|
-
| Enterprise | Mission-critical |
|
|
193
|
+
| Tier | Purpose | Code Lines | Best For |
|
|
194
|
+
| ---------- | ---------------- | ---------- | --------------------------- |
|
|
195
|
+
| Basic | Prototype, MVP | 30-50 | Quick prototypes, demos |
|
|
196
|
+
| Standard | Production | 50-150 | Most production apps |
|
|
197
|
+
| Enterprise | Mission-critical | 150-300 | Large-scale, high-traffic |
|
|
198
|
+
|
|
199
|
+
**What's included in each tier**:
|
|
200
|
+
- **Basic**: Core functionality, basic styling
|
|
201
|
+
- **Standard**: Multiple variants, responsive design, accessibility basics
|
|
202
|
+
- **Enterprise**: Full accessibility (ARIA), analytics, performance optimization, comprehensive error handling
|
|
220
203
|
|
|
221
204
|
## Examples
|
|
222
205
|
|
|
223
|
-
###
|
|
206
|
+
### Quick Component Generation
|
|
224
207
|
|
|
225
208
|
```bash
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
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
|
|
209
|
+
# Material Design button (Standard tier)
|
|
210
|
+
nikkory-vibe add button
|
|
235
211
|
|
|
236
|
-
|
|
212
|
+
# iOS-style card (Enterprise tier)
|
|
213
|
+
nikkory-vibe add card -s ios-hig -t enterprise
|
|
237
214
|
|
|
238
|
-
|
|
239
|
-
nikkory-vibe add
|
|
215
|
+
# Glassmorphism modal
|
|
216
|
+
nikkory-vibe add modal -s glassmorphism
|
|
240
217
|
```
|
|
241
218
|
|
|
242
|
-
|
|
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
|
|
219
|
+
### Section Generation
|
|
250
220
|
|
|
251
221
|
```bash
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
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
|
|
222
|
+
# Hero section
|
|
223
|
+
nikkory-vibe add:section hero-centered
|
|
260
224
|
|
|
261
|
-
|
|
225
|
+
# Pricing table
|
|
226
|
+
nikkory-vibe add:section pricing-cards -t enterprise
|
|
262
227
|
|
|
263
|
-
|
|
264
|
-
nikkory-vibe add
|
|
265
|
-
"borderRadius": "rounded-full",
|
|
266
|
-
"shadowIntensity": "high",
|
|
267
|
-
"animation": "enabled"
|
|
268
|
-
}'
|
|
228
|
+
# Testimonials grid
|
|
229
|
+
nikkory-vibe add:section testimonials-grid -s minimalism
|
|
269
230
|
```
|
|
270
231
|
|
|
271
|
-
|
|
232
|
+
### Full Page Generation
|
|
272
233
|
|
|
273
|
-
|
|
234
|
+
```bash
|
|
235
|
+
# Landing page with multiple sections
|
|
236
|
+
nikkory-vibe add:page landing -s material-design -t standard
|
|
274
237
|
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
Component (24 factors)
|
|
238
|
+
# Dashboard with data tables
|
|
239
|
+
nikkory-vibe add:page dashboard -s carbon -t enterprise
|
|
240
|
+
|
|
241
|
+
# Auth flow
|
|
242
|
+
nikkory-vibe add:page auth -s ios-hig
|
|
281
243
|
```
|
|
282
244
|
|
|
283
|
-
|
|
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
|
|
245
|
+
### Custom Output Paths
|
|
305
246
|
|
|
306
|
-
|
|
247
|
+
```bash
|
|
248
|
+
# Component to specific path
|
|
249
|
+
nikkory-vibe add button -o src/components/ui/Button.tsx
|
|
307
250
|
|
|
308
|
-
|
|
251
|
+
# Section to features directory
|
|
252
|
+
nikkory-vibe add:section hero-centered -o src/features/landing/Hero.tsx
|
|
309
253
|
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
"defaultDesignSystem": "material-design",
|
|
313
|
-
"defaultTier": "standard",
|
|
314
|
-
"outputDir": "src/components"
|
|
315
|
-
}
|
|
254
|
+
# Page to pages directory
|
|
255
|
+
nikkory-vibe add:page landing -o src/pages/LandingPage.tsx
|
|
316
256
|
```
|
|
317
257
|
|
|
318
|
-
## Statistics
|
|
319
|
-
|
|
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)
|
|
323
|
-
|
|
324
258
|
## CLI Shortcuts
|
|
325
259
|
|
|
326
|
-
|
|
260
|
+
Use `vibe` as a shorter alias:
|
|
327
261
|
|
|
328
262
|
```bash
|
|
329
263
|
# These are equivalent
|
|
330
264
|
nikkory-vibe add button
|
|
331
265
|
vibe add button
|
|
332
266
|
|
|
333
|
-
# Section
|
|
267
|
+
# Section shortcuts
|
|
334
268
|
vibe add:section hero-centered
|
|
335
269
|
vibe section hero-centered
|
|
336
270
|
|
|
337
|
-
# Page
|
|
271
|
+
# Page shortcuts
|
|
338
272
|
vibe add:page landing
|
|
339
273
|
vibe page landing
|
|
340
274
|
```
|
|
341
275
|
|
|
276
|
+
## Configuration
|
|
277
|
+
|
|
278
|
+
Create `.viberc.json` in your project root:
|
|
279
|
+
|
|
280
|
+
```json
|
|
281
|
+
{
|
|
282
|
+
"defaultDesignSystem": "material-design",
|
|
283
|
+
"defaultTier": "standard",
|
|
284
|
+
"outputDir": "src/components"
|
|
285
|
+
}
|
|
286
|
+
```
|
|
287
|
+
|
|
342
288
|
## Integration
|
|
343
289
|
|
|
344
290
|
### With React Projects
|
|
@@ -368,11 +314,58 @@ Install the Nikkory Vibe VSCode extension for:
|
|
|
368
314
|
- Template preview
|
|
369
315
|
- Syntax highlighting
|
|
370
316
|
|
|
317
|
+
## What Gets Generated
|
|
318
|
+
|
|
319
|
+
### Components
|
|
320
|
+
- Full TypeScript React components
|
|
321
|
+
- Complete type definitions
|
|
322
|
+
- Variants and sizes
|
|
323
|
+
- Responsive design
|
|
324
|
+
- Accessibility attributes
|
|
325
|
+
- Documentation comments
|
|
326
|
+
|
|
327
|
+
### Sections
|
|
328
|
+
- Multiple composed components
|
|
329
|
+
- Consistent design system
|
|
330
|
+
- Layout and spacing
|
|
331
|
+
- Responsive breakpoints
|
|
332
|
+
- SEO-friendly markup
|
|
333
|
+
|
|
334
|
+
### Pages
|
|
335
|
+
- Complete page structure
|
|
336
|
+
- Multiple coordinated sections
|
|
337
|
+
- Unified color scheme
|
|
338
|
+
- Professional layouts
|
|
339
|
+
- Production-ready code
|
|
340
|
+
|
|
341
|
+
## Common Use Cases
|
|
342
|
+
|
|
343
|
+
**Rapid Prototyping**: Use Basic tier for quick UI mockups
|
|
344
|
+
```bash
|
|
345
|
+
vibe add button -t basic
|
|
346
|
+
vibe add card -t basic
|
|
347
|
+
vibe add:section hero-centered -t basic
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
**Production Apps**: Use Standard tier for most features
|
|
351
|
+
```bash
|
|
352
|
+
vibe add button -t standard
|
|
353
|
+
vibe add:section pricing-cards -t standard
|
|
354
|
+
vibe add:page landing -t standard
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
**Enterprise Projects**: Use Enterprise tier for critical features
|
|
358
|
+
```bash
|
|
359
|
+
vibe add button -t enterprise
|
|
360
|
+
vibe add:section hero-centered -t enterprise
|
|
361
|
+
vibe add:page dashboard -t enterprise
|
|
362
|
+
```
|
|
363
|
+
|
|
371
364
|
## Support
|
|
372
365
|
|
|
373
366
|
- **Website**: https://nikkory.com
|
|
367
|
+
- **Documentation**: https://nikkory.com/docs
|
|
374
368
|
- **Issues**: [GitHub Issues](https://github.com/kemonra/nikkory-vibe/issues)
|
|
375
|
-
- **Documentation**: [Full Docs](https://nikkory.com/docs)
|
|
376
369
|
|
|
377
370
|
## License
|
|
378
371
|
|
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.
|
|
1587
|
+
${y(" happy together")} ${import_chalk5.default.white("\u2022 v2.3.2")}
|
|
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.
|
|
1595
|
+
program.name("nikkory-vibe").description("Nikkory Vibe - Production-ready code in seconds").version("2.3.2").addHelpText("before", banner);
|
|
1596
1596
|
program.addCommand(matrixGenerateCommand);
|
|
1597
1597
|
program.addCommand(sectionGenerateCommand);
|
|
1598
1598
|
program.addCommand(pageGenerateCommand);
|