@nikkory/vibe-cli 2.3.0 → 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.
Files changed (3) hide show
  1. package/README.md +260 -144
  2. package/dist/index.js +2 -2
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,193 +1,277 @@
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, 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
4
16
 
5
17
  ## Installation
6
18
 
7
19
  ```bash
8
- # Global installation
20
+ # npm
21
+ npm install -g @nikkory/vibe-cli
22
+
23
+ # pnpm
9
24
  pnpm add -g @nikkory/vibe-cli
10
25
 
11
- # Local installation
12
- pnpm add -D @nikkory/vibe-cli
26
+ # yarn
27
+ yarn global add @nikkory/vibe-cli
13
28
  ```
14
29
 
15
30
  ## Quick Start
16
31
 
17
32
  ```bash
18
33
  # Initialize new project
19
- vibe init my-app
34
+ nikkory-vibe init my-app
20
35
 
21
- # Generate component
22
- vibe generate component MyButton --design material-design
36
+ # Add a component
37
+ nikkory-vibe add button
38
+
39
+ # Add a section
40
+ nikkory-vibe add:section hero-centered
41
+
42
+ # Add a full page
43
+ nikkory-vibe add:page landing
23
44
 
24
45
  # List available options
25
- vibe list
46
+ nikkory-vibe list
26
47
  ```
27
48
 
28
49
  ## Commands
29
50
 
30
- ### `vibe init`
51
+ ### `nikkory-vibe add` (aliases: `gen`, `generate`)
31
52
 
32
- Initialize a new Nikkory Vibe project.
53
+ Generate UI components instantly.
33
54
 
34
55
  ```bash
35
- vibe init my-app
36
- vibe init my-app --framework react --design material-design
37
- vibe init my-app --backend --no-install
56
+ # Basic usage
57
+ nikkory-vibe add button
58
+
59
+ # Specify design system
60
+ nikkory-vibe add button -s ios-hig
61
+
62
+ # Choose quality tier
63
+ nikkory-vibe add button -t enterprise
64
+
65
+ # Custom output path
66
+ nikkory-vibe add card -o src/components/Card.tsx
67
+
68
+ # Advanced customization
69
+ nikkory-vibe add button --factor-overrides '{"borderRadius":"rounded-full"}'
38
70
  ```
39
71
 
72
+ **Arguments:**
73
+ - `<component>` - Component type (button, input, card, modal, etc.)
74
+
40
75
  **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
76
+ - `-s, --design-system <system>` - Design system (default: `material-design`)
77
+ - `-t, --tier <tier>` - Quality tier: basic, standard, enterprise (default: `standard`)
78
+ - `-f, --factor-overrides <json>` - Advanced customization (JSON)
79
+ - `-o, --output <path>` - Output file path
45
80
 
46
- ### `vibe generate` (alias: `g`)
81
+ ### `nikkory-vibe add:section` (alias: `section`)
47
82
 
48
- Generate components from templates.
83
+ Generate complete sections with multiple components.
49
84
 
50
85
  ```bash
51
- # Basic usage
52
- vibe generate component MyButton
86
+ # Generate hero section
87
+ nikkory-vibe add:section hero-centered
53
88
 
54
- # Specify design system and tier
55
- vibe generate component ActionButton --design ios-hig --tier enterprise
89
+ # Generate pricing section
90
+ nikkory-vibe add:section pricing-cards -s material-design -t enterprise
56
91
 
57
- # Interactive mode
58
- vibe generate --interactive
92
+ # Custom output
93
+ nikkory-vibe add:section testimonials-grid -o src/sections/Testimonials.tsx
94
+ ```
59
95
 
60
- # Dry run (preview without writing)
61
- vibe generate component Card --dry-run
96
+ **Arguments:**
97
+ - `<section>` - Section type (hero-centered, pricing-cards, features-grid, etc.)
62
98
 
63
- # Custom output path
64
- vibe generate component LoginForm --output src/features/auth/LoginForm.tsx
99
+ **Options:**
100
+ - `-s, --design-system <system>` - Design system (default: `material-design`)
101
+ - `-t, --tier <tier>` - Quality tier: basic, standard, enterprise (default: `standard`)
102
+ - `-o, --output <path>` - Output file path
103
+
104
+ ### `nikkory-vibe add:page` (alias: `page`)
105
+
106
+ Generate complete pages with multiple sections.
107
+
108
+ ```bash
109
+ # Generate landing page
110
+ nikkory-vibe add:page landing
111
+
112
+ # Generate dashboard
113
+ nikkory-vibe add:page dashboard -s ios-hig -t enterprise
114
+
115
+ # Custom output
116
+ nikkory-vibe add:page auth -o src/pages/AuthPage.tsx
65
117
  ```
66
118
 
67
119
  **Arguments:**
68
- - `[type]` - Type to generate (component, section, page) - default: component
120
+ - `<page>` - Page type (landing, dashboard, auth, pricing, etc.)
69
121
 
70
122
  **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
123
+ - `-s, --design-system <system>` - Design system (default: `material-design`)
124
+ - `-t, --tier <tier>` - Quality tier: basic, standard, enterprise (default: `standard`)
76
125
  - `-o, --output <path>` - Output file path
77
- - `--dry-run` - Preview generated code without writing
78
- - `--interactive` - Interactive mode with prompts
79
126
 
80
- ### `vibe list` (alias: `ls`)
127
+ ### `nikkory-vibe list` (alias: `ls`)
81
128
 
82
- List available templates and design systems.
129
+ Browse available templates and options.
83
130
 
84
131
  ```bash
85
132
  # List everything
86
- vibe list
133
+ nikkory-vibe list
87
134
 
88
- # List specific category
89
- vibe list templates
90
- vibe list designs
91
- vibe list tiers
92
- vibe list frameworks
135
+ # List by category
136
+ nikkory-vibe list components
137
+ nikkory-vibe list sections
138
+ nikkory-vibe list design-systems
139
+ nikkory-vibe list tiers
93
140
 
94
141
  # JSON output
95
- vibe list --json
142
+ nikkory-vibe list --json
96
143
  ```
97
144
 
98
145
  **Arguments:**
99
- - `[category]` - Category to list (templates, designs, tiers, frameworks, all)
146
+ - `[category]` - Category to list (components, sections, design-systems, tiers, all)
100
147
 
101
148
  **Options:**
102
149
  - `--json` - Output as JSON
103
150
 
104
- ## Examples
151
+ ### `nikkory-vibe init`
105
152
 
106
- ### Generate Material Design Button
153
+ Initialize a new project.
107
154
 
108
155
  ```bash
109
- vibe g component SubmitButton \
110
- --design material-design \
111
- --tier standard \
112
- --framework react
113
- ```
156
+ # Basic usage
157
+ nikkory-vibe init my-app
114
158
 
115
- ### Generate iOS-style Card (Enterprise)
159
+ # With framework
160
+ nikkory-vibe init my-app --framework react
116
161
 
117
- ```bash
118
- vibe g component ProfileCard \
119
- --design ios-hig \
120
- --tier enterprise \
121
- --output src/components/ProfileCard.tsx
162
+ # Skip installation
163
+ nikkory-vibe init my-app --no-install
122
164
  ```
123
165
 
124
- ### Interactive Component Generation
166
+ **Arguments:**
167
+ - `[project-name]` - Project name (optional)
168
+
169
+ **Options:**
170
+ - `-f, --framework <framework>` - Frontend framework (react, vue, angular)
171
+ - `-d, --design <system>` - Default design system
172
+ - `--no-install` - Skip dependency installation
173
+
174
+ ## Design Systems
175
+
176
+ | Design System | ID | Description |
177
+ | ---------------- | ---------------- | -------------------------------- |
178
+ | Material Design | `material-design`| Google's design language |
179
+ | iOS HIG | `ios-hig` | Apple Human Interface Guidelines |
180
+ | Glassmorphism | `glassmorphism` | Frosted glass effect |
181
+ | Neumorphism | `neumorphism` | Soft UI with shadows |
182
+ | Brutalism | `brutalism` | Bold, raw aesthetic |
183
+ | Minimalism | `minimalism` | Clean, simple design |
184
+ | Fluent | `fluent` | Microsoft Fluent Design |
185
+ | Carbon | `carbon` | IBM Carbon Design System |
186
+ | Ant Design | `ant-design` | Ant Design (Alibaba) |
187
+ | Chakra | `chakra` | Chakra UI style |
188
+ | Atlassian | `atlassian` | Atlassian Design System |
189
+ | Blueprint | `blueprint` | Palantir Blueprint |
190
+
191
+ ## Quality Tiers
192
+
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
203
+
204
+ ## Examples
205
+
206
+ ### Quick Component Generation
125
207
 
126
208
  ```bash
127
- vibe g --interactive
128
- ```
209
+ # Material Design button (Standard tier)
210
+ nikkory-vibe add button
211
+
212
+ # iOS-style card (Enterprise tier)
213
+ nikkory-vibe add card -s ios-hig -t enterprise
129
214
 
130
- This will prompt you for:
131
- - Component name
132
- - Template type
133
- - Design system
134
- - Quality tier
135
- - Framework
215
+ # Glassmorphism modal
216
+ nikkory-vibe add modal -s glassmorphism
217
+ ```
136
218
 
137
- ### Preview Before Writing
219
+ ### Section Generation
138
220
 
139
221
  ```bash
140
- vibe g component Hero --design glassmorphism --dry-run
222
+ # Hero section
223
+ nikkory-vibe add:section hero-centered
224
+
225
+ # Pricing table
226
+ nikkory-vibe add:section pricing-cards -t enterprise
227
+
228
+ # Testimonials grid
229
+ nikkory-vibe add:section testimonials-grid -s minimalism
141
230
  ```
142
231
 
143
- ### Initialize Full-Stack Project
232
+ ### Full Page Generation
144
233
 
145
234
  ```bash
146
- vibe init my-saas-app \
147
- --framework react \
148
- --design material-design \
149
- --backend
235
+ # Landing page with multiple sections
236
+ nikkory-vibe add:page landing -s material-design -t standard
237
+
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
150
243
  ```
151
244
 
152
- ## Available Options
245
+ ### Custom Output Paths
153
246
 
154
- ### Templates
247
+ ```bash
248
+ # Component to specific path
249
+ nikkory-vibe add button -o src/components/ui/Button.tsx
155
250
 
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
251
+ # Section to features directory
252
+ nikkory-vibe add:section hero-centered -o src/features/landing/Hero.tsx
166
253
 
167
- ### Design Systems
254
+ # Page to pages directory
255
+ nikkory-vibe add:page landing -o src/pages/LandingPage.tsx
256
+ ```
168
257
 
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
258
+ ## CLI Shortcuts
177
259
 
178
- ### Quality Tiers
260
+ Use `vibe` as a shorter alias:
179
261
 
180
- - `basic` - Prototype/demo quality (~60 LOC)
181
- - `standard` - Production-ready (~200 LOC)
182
- - `enterprise` - Mission-critical (~350 LOC)
262
+ ```bash
263
+ # These are equivalent
264
+ nikkory-vibe add button
265
+ vibe add button
183
266
 
184
- ### Frameworks
267
+ # Section shortcuts
268
+ vibe add:section hero-centered
269
+ vibe section hero-centered
185
270
 
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)
271
+ # Page shortcuts
272
+ vibe add:page landing
273
+ vibe page landing
274
+ ```
191
275
 
192
276
  ## Configuration
193
277
 
@@ -197,60 +281,91 @@ Create `.viberc.json` in your project root:
197
281
  {
198
282
  "defaultDesignSystem": "material-design",
199
283
  "defaultTier": "standard",
200
- "defaultFramework": "react",
201
- "outputDir": "src/components",
202
- "fileExtension": "tsx"
284
+ "outputDir": "src/components"
203
285
  }
204
286
  ```
205
287
 
206
- ## Environment Variables
207
-
208
- - `DEBUG=true` - Enable debug logging
209
- - `VIBE_OUTPUT_DIR` - Default output directory
288
+ ## Integration
210
289
 
211
- ## Troubleshooting
212
-
213
- ### Template Not Found
290
+ ### With React Projects
214
291
 
215
292
  ```bash
216
- vibe list templates # Check available templates
217
- ```
293
+ # Install CLI
294
+ pnpm add -D @nikkory/vibe-cli
218
295
 
219
- ### Permission Denied
296
+ # Add to package.json scripts
297
+ {
298
+ "scripts": {
299
+ "vibe": "nikkory-vibe",
300
+ "vibe:add": "nikkory-vibe add",
301
+ "vibe:section": "nikkory-vibe add:section"
302
+ }
303
+ }
220
304
 
221
- ```bash
222
- # Run with appropriate permissions or change output directory
223
- vibe g component Button --output ./Button.tsx
305
+ # Use in your project
306
+ pnpm vibe add button -o src/components/Button.tsx
224
307
  ```
225
308
 
226
- ### Import Errors
309
+ ### With VSCode
227
310
 
228
- Make sure your project has the required dependencies:
311
+ Install the Nikkory Vibe VSCode extension for:
312
+ - Command palette integration
313
+ - Right-click context menu
314
+ - Template preview
315
+ - Syntax highlighting
229
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
230
344
  ```bash
231
- pnpm add react react-dom
232
- pnpm add -D @types/react @types/react-dom
345
+ vibe add button -t basic
346
+ vibe add card -t basic
347
+ vibe add:section hero-centered -t basic
233
348
  ```
234
349
 
235
- ## CLI Output
236
-
237
- The CLI provides rich, colorful output:
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
+ ```
238
356
 
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
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
+ ```
246
363
 
247
- ## Integration with VSCode
364
+ ## Support
248
365
 
249
- Install the Nikkory Vibe VSCode extension for:
250
- - Command palette integration
251
- - Right-click context menu
252
- - Template preview
253
- - Syntax highlighting
366
+ - **Website**: https://nikkory.com
367
+ - **Documentation**: https://nikkory.com/docs
368
+ - **Issues**: [GitHub Issues](https://github.com/kemonra/nikkory-vibe/issues)
254
369
 
255
370
  ## License
256
371
 
@@ -258,4 +373,5 @@ MIT
258
373
 
259
374
  ---
260
375
 
261
- Powered by Nikkory
376
+ **Powered by Nikkory**
377
+ 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.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.0").addHelpText("before", banner);
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);
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.2",
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",