kimu-cli 1.3.0 → 1.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.
@@ -1,335 +1,335 @@
1
- # KIMU-CLI Quick Reference
2
-
3
- A quick reference guide for the most common KIMU-CLI commands and workflows.
4
-
5
- ## Installation
6
-
7
- ```bash
8
- # Global installation (recommended)
9
- npm install -g kimu-cli
10
-
11
- # Check installation
12
- kimu --version
13
-
14
- # Update to latest version
15
- npm update -g kimu-cli
16
- ```
17
-
18
- ## Project Creation
19
-
20
- ```bash
21
- # Basic project creation
22
- kimu create my-app
23
-
24
- # With git initialization
25
- kimu create my-app --git
26
-
27
- # Skip npm install (manual installation later)
28
- kimu create my-app --no-install
29
-
30
- # Force overwrite existing directory
31
- kimu create my-app --force
32
-
33
- # Using npx (no global installation)
34
- npx kimu-cli create my-app
35
- ```
36
-
37
- ## Component Generation
38
-
39
- ```bash
40
- # Create new extension
41
- kimu new extension my-feature
42
-
43
- # Create new module
44
- kimu new module analytics
45
-
46
- # With custom path
47
- kimu new extension my-feature --path src/extensions/custom
48
-
49
- # Force overwrite
50
- kimu new extension my-feature --force
51
-
52
- # Skip auto-registration
53
- kimu new module analytics --no-register
54
- ```
55
-
56
- ## Project Information
57
-
58
- ```bash
59
- # Basic project info
60
- kimu info
61
-
62
- # Detailed information
63
- kimu info --verbose
64
-
65
- # JSON output (for scripts)
66
- kimu info --json
67
- ```
68
-
69
- ## Version Information
70
-
71
- ```bash
72
- # CLI version
73
- kimu --version
74
-
75
- # Detailed version info
76
- kimu version --verbose
77
- ```
78
-
79
- ## Help System
80
-
81
- ```bash
82
- # General help
83
- kimu --help
84
-
85
- # Command-specific help
86
- kimu create --help
87
- kimu info --help
88
- kimu version --help
89
-
90
- # Help command
91
- kimu help
92
- kimu help create
93
- ```
94
-
95
- ## NPM Scripts (After Project Creation)
96
-
97
- Once you've created a project with `kimu create`, use these npm scripts:
98
-
99
- ```bash
100
- # Start development server
101
- npm run dev
102
-
103
- # Build for production
104
- npm run build
105
-
106
- # Preview production build
107
- npm run preview
108
-
109
- # Run linter
110
- npm run lint
111
-
112
- # Generate dev build config
113
- npm run generate-config:dev
114
-
115
- # Generate production build config
116
- npm run generate-config:prod
117
- ```
118
-
119
- ## Common Workflows
120
-
121
- ### 1. Start a New Project
122
- ```bash
123
- # Create project
124
- kimu create my-project --git
125
-
126
- # Navigate to it
127
- cd my-project
128
-
129
- # Start development
130
- npm run dev
131
- ```
132
-
133
- ### 2. Check Project Details
134
- ```bash
135
- # Navigate to project
136
- cd my-project
137
-
138
- # View project information
139
- kimu info --verbose
140
- ```
141
-
142
- ### 3. Build and Deploy
143
- ```bash
144
- # Navigate to project
145
- cd my-project
146
-
147
- # Generate production config
148
- npm run generate-config:prod
149
-
150
- # Build for production
151
- npm run build
152
-
153
- # Test production build locally
154
- npm run preview
155
-
156
- # Deploy dist/ folder to your hosting
157
- ```
158
-
159
- ### 4. Update KIMU CLI
160
- ```bash
161
- # Check current version
162
- kimu --version
163
-
164
- # Update to latest
165
- npm update -g kimu-cli
166
-
167
- # Verify update
168
- kimu --version
169
- ```
170
-
171
- ## Project Structure Reference
172
-
173
- ```
174
- my-project/
175
- ├── src/
176
- │ ├── core/ # KIMU framework core
177
- │ ├── extensions/ # UI extensions
178
- │ ├── modules/ # Modules (router, i18n)
179
- │ └── main.ts # Application entry
180
- ├── public/ # Static assets
181
- ├── scripts/ # Build scripts
182
- ├── dist/ # Build output
183
- ├── kimu.config.json # KIMU configuration
184
- ├── kimu-build-config.ts # Build config (generated)
185
- ├── package.json # Dependencies
186
- ├── tsconfig.json # TypeScript config
187
- ├── vite.config.ts # Vite config
188
- └── README.md # Project docs
189
- ```
190
-
191
- ## Key Configuration Files
192
-
193
- ### kimu.config.json
194
- ```json
195
- {
196
- "name": "my-project",
197
- "version": "1.0.0",
198
- "kimuCore": "^0.4.0",
199
- "modules": {
200
- "installed": [],
201
- "registry": "https://github.com/unicoverso/kimu-modules"
202
- },
203
- "extensions": {
204
- "installed": ["app-root"],
205
- "main": "app-root"
206
- }
207
- }
208
- ```
209
-
210
- ### package.json (key scripts)
211
- ```json
212
- {
213
- "scripts": {
214
- "dev": "vite",
215
- "build": "vite build",
216
- "preview": "vite preview",
217
- "lint": "eslint src/**/*.ts"
218
- }
219
- }
220
- ```
221
-
222
- ## Environment Variables
223
-
224
- Create a `.env` file in your project root:
225
-
226
- ```bash
227
- # Development
228
- VITE_API_URL=http://localhost:3000
229
- VITE_ENV=development
230
-
231
- # Production
232
- VITE_API_URL=https://api.myapp.com
233
- VITE_ENV=production
234
- ```
235
-
236
- Access in code:
237
- ```typescript
238
- const apiUrl = import.meta.env.VITE_API_URL;
239
- ```
240
-
241
- ## Troubleshooting
242
-
243
- ### Command not found: kimu
244
- ```bash
245
- # Check npm global bin location
246
- npm config get prefix
247
-
248
- # Add to PATH (bash/zsh)
249
- echo 'export PATH="$(npm config get prefix)/bin:$PATH"' >> ~/.zshrc
250
- source ~/.zshrc
251
- ```
252
-
253
- ### Port already in use
254
- ```bash
255
- # Kill process on port 5173
256
- lsof -ti:5173 | xargs kill -9
257
-
258
- # Or use different port
259
- vite --port 3000
260
- ```
261
-
262
- ### Clean install
263
- ```bash
264
- # Remove dependencies and build
265
- rm -rf node_modules dist
266
-
267
- # Reinstall
268
- npm install
269
-
270
- # Rebuild
271
- npm run build
272
- ```
273
-
274
- ### Update dependencies
275
- ```bash
276
- # Check for updates
277
- npm outdated
278
-
279
- # Update all dependencies
280
- npm update
281
-
282
- # Update specific package
283
- npm update kimu-core
284
- ```
285
-
286
- ## Tips and Tricks
287
-
288
- ### Faster npm installs
289
- ```bash
290
- # Use npm ci for clean installs (faster)
291
- npm ci
292
-
293
- # Or use pnpm (faster alternative)
294
- npm install -g pnpm
295
- pnpm install
296
- ```
297
-
298
- ### Development mode with custom port
299
- ```bash
300
- # Edit package.json
301
- "dev": "vite --port 3000 --host"
302
-
303
- # Or use CLI flag
304
- npm run dev -- --port 3000
305
- ```
306
-
307
- ### Production build analysis
308
- ```bash
309
- # Install bundle analyzer
310
- npm install --save-dev rollup-plugin-visualizer
311
-
312
- # Add to vite.config.ts for build stats
313
- ```
314
-
315
- ### Git workflow
316
- ```bash
317
- # Initial commit (if created with --git)
318
- git add .
319
- git commit -m "Initial commit"
320
-
321
- # Add remote and push
322
- git remote add origin <your-repo-url>
323
- git push -u origin main
324
- ```
325
-
326
- ## Next Steps
327
-
328
- - **Documentation**: [Full Docs](../docs/index.md)
329
- - **Getting Started**: [Complete Tutorial](getting-started.md)
330
- - **Commands**: [Command Reference](command-kimu.md)
331
- - **Examples**: [KIMU Examples](https://github.com/UnicoVerso/kimu-extensions-example)
332
-
333
- ---
334
-
335
- Need more help? Check the [complete documentation](index.md) or [open an issue](https://github.com/UnicoVerso/kimu-cli/issues).
1
+ # KIMU-CLI Quick Reference
2
+
3
+ A quick reference guide for the most common KIMU-CLI commands and workflows.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ # Global installation (recommended)
9
+ npm install -g kimu-cli
10
+
11
+ # Check installation
12
+ kimu --version
13
+
14
+ # Update to latest version
15
+ npm update -g kimu-cli
16
+ ```
17
+
18
+ ## Project Creation
19
+
20
+ ```bash
21
+ # Basic project creation
22
+ kimu create my-app
23
+
24
+ # With git initialization
25
+ kimu create my-app --git
26
+
27
+ # Skip npm install (manual installation later)
28
+ kimu create my-app --no-install
29
+
30
+ # Force overwrite existing directory
31
+ kimu create my-app --force
32
+
33
+ # Using npx (no global installation)
34
+ npx kimu-cli create my-app
35
+ ```
36
+
37
+ ## Component Generation
38
+
39
+ ```bash
40
+ # Create new extension
41
+ kimu new extension my-feature
42
+
43
+ # Create new module
44
+ kimu new module analytics
45
+
46
+ # With custom path
47
+ kimu new extension my-feature --path src/extensions/custom
48
+
49
+ # Force overwrite
50
+ kimu new extension my-feature --force
51
+
52
+ # Skip auto-registration
53
+ kimu new module analytics --no-register
54
+ ```
55
+
56
+ ## Project Information
57
+
58
+ ```bash
59
+ # Basic project info
60
+ kimu info
61
+
62
+ # Detailed information
63
+ kimu info --verbose
64
+
65
+ # JSON output (for scripts)
66
+ kimu info --json
67
+ ```
68
+
69
+ ## Version Information
70
+
71
+ ```bash
72
+ # CLI version
73
+ kimu --version
74
+
75
+ # Detailed version info
76
+ kimu version --verbose
77
+ ```
78
+
79
+ ## Help System
80
+
81
+ ```bash
82
+ # General help
83
+ kimu --help
84
+
85
+ # Command-specific help
86
+ kimu create --help
87
+ kimu info --help
88
+ kimu version --help
89
+
90
+ # Help command
91
+ kimu help
92
+ kimu help create
93
+ ```
94
+
95
+ ## NPM Scripts (After Project Creation)
96
+
97
+ Once you've created a project with `kimu create`, use these npm scripts:
98
+
99
+ ```bash
100
+ # Start development server
101
+ npm run dev
102
+
103
+ # Build for production
104
+ npm run build
105
+
106
+ # Preview production build
107
+ npm run preview
108
+
109
+ # Run linter
110
+ npm run lint
111
+
112
+ # Generate dev build config
113
+ npm run generate-config:dev
114
+
115
+ # Generate production build config
116
+ npm run generate-config:prod
117
+ ```
118
+
119
+ ## Common Workflows
120
+
121
+ ### 1. Start a New Project
122
+ ```bash
123
+ # Create project
124
+ kimu create my-project --git
125
+
126
+ # Navigate to it
127
+ cd my-project
128
+
129
+ # Start development
130
+ npm run dev
131
+ ```
132
+
133
+ ### 2. Check Project Details
134
+ ```bash
135
+ # Navigate to project
136
+ cd my-project
137
+
138
+ # View project information
139
+ kimu info --verbose
140
+ ```
141
+
142
+ ### 3. Build and Deploy
143
+ ```bash
144
+ # Navigate to project
145
+ cd my-project
146
+
147
+ # Generate production config
148
+ npm run generate-config:prod
149
+
150
+ # Build for production
151
+ npm run build
152
+
153
+ # Test production build locally
154
+ npm run preview
155
+
156
+ # Deploy dist/ folder to your hosting
157
+ ```
158
+
159
+ ### 4. Update KIMU CLI
160
+ ```bash
161
+ # Check current version
162
+ kimu --version
163
+
164
+ # Update to latest
165
+ npm update -g kimu-cli
166
+
167
+ # Verify update
168
+ kimu --version
169
+ ```
170
+
171
+ ## Project Structure Reference
172
+
173
+ ```
174
+ my-project/
175
+ ├── src/
176
+ │ ├── core/ # KIMU framework core
177
+ │ ├── extensions/ # UI extensions
178
+ │ ├── modules/ # Modules (router, i18n)
179
+ │ └── main.ts # Application entry
180
+ ├── public/ # Static assets
181
+ ├── scripts/ # Build scripts
182
+ ├── dist/ # Build output
183
+ ├── kimu.config.json # KIMU configuration
184
+ ├── kimu-build-config.ts # Build config (generated)
185
+ ├── package.json # Dependencies
186
+ ├── tsconfig.json # TypeScript config
187
+ ├── vite.config.ts # Vite config
188
+ └── README.md # Project docs
189
+ ```
190
+
191
+ ## Key Configuration Files
192
+
193
+ ### kimu.config.json
194
+ ```json
195
+ {
196
+ "name": "my-project",
197
+ "version": "1.0.0",
198
+ "kimuCore": "^0.4.0",
199
+ "modules": {
200
+ "installed": [],
201
+ "registry": "https://github.com/unicoverso/kimu-modules"
202
+ },
203
+ "extensions": {
204
+ "installed": ["app-root"],
205
+ "main": "app-root"
206
+ }
207
+ }
208
+ ```
209
+
210
+ ### package.json (key scripts)
211
+ ```json
212
+ {
213
+ "scripts": {
214
+ "dev": "vite",
215
+ "build": "vite build",
216
+ "preview": "vite preview",
217
+ "lint": "eslint src/**/*.ts"
218
+ }
219
+ }
220
+ ```
221
+
222
+ ## Environment Variables
223
+
224
+ Create a `.env` file in your project root:
225
+
226
+ ```bash
227
+ # Development
228
+ VITE_API_URL=http://localhost:3000
229
+ VITE_ENV=development
230
+
231
+ # Production
232
+ VITE_API_URL=https://api.myapp.com
233
+ VITE_ENV=production
234
+ ```
235
+
236
+ Access in code:
237
+ ```typescript
238
+ const apiUrl = import.meta.env.VITE_API_URL;
239
+ ```
240
+
241
+ ## Troubleshooting
242
+
243
+ ### Command not found: kimu
244
+ ```bash
245
+ # Check npm global bin location
246
+ npm config get prefix
247
+
248
+ # Add to PATH (bash/zsh)
249
+ echo 'export PATH="$(npm config get prefix)/bin:$PATH"' >> ~/.zshrc
250
+ source ~/.zshrc
251
+ ```
252
+
253
+ ### Port already in use
254
+ ```bash
255
+ # Kill process on port 5173
256
+ lsof -ti:5173 | xargs kill -9
257
+
258
+ # Or use different port
259
+ vite --port 3000
260
+ ```
261
+
262
+ ### Clean install
263
+ ```bash
264
+ # Remove dependencies and build
265
+ rm -rf node_modules dist
266
+
267
+ # Reinstall
268
+ npm install
269
+
270
+ # Rebuild
271
+ npm run build
272
+ ```
273
+
274
+ ### Update dependencies
275
+ ```bash
276
+ # Check for updates
277
+ npm outdated
278
+
279
+ # Update all dependencies
280
+ npm update
281
+
282
+ # Update specific package
283
+ npm update kimu-core
284
+ ```
285
+
286
+ ## Tips and Tricks
287
+
288
+ ### Faster npm installs
289
+ ```bash
290
+ # Use npm ci for clean installs (faster)
291
+ npm ci
292
+
293
+ # Or use pnpm (faster alternative)
294
+ npm install -g pnpm
295
+ pnpm install
296
+ ```
297
+
298
+ ### Development mode with custom port
299
+ ```bash
300
+ # Edit package.json
301
+ "dev": "vite --port 3000 --host"
302
+
303
+ # Or use CLI flag
304
+ npm run dev -- --port 3000
305
+ ```
306
+
307
+ ### Production build analysis
308
+ ```bash
309
+ # Install bundle analyzer
310
+ npm install --save-dev rollup-plugin-visualizer
311
+
312
+ # Add to vite.config.ts for build stats
313
+ ```
314
+
315
+ ### Git workflow
316
+ ```bash
317
+ # Initial commit (if created with --git)
318
+ git add .
319
+ git commit -m "Initial commit"
320
+
321
+ # Add remote and push
322
+ git remote add origin <your-repo-url>
323
+ git push -u origin main
324
+ ```
325
+
326
+ ## Next Steps
327
+
328
+ - **Documentation**: [Full Docs](../docs/index.md)
329
+ - **Getting Started**: [Complete Tutorial](getting-started.md)
330
+ - **Commands**: [Command Reference](command-kimu.md)
331
+ - **Examples**: [KIMU Examples](https://github.com/UnicoVerso/kimu-extensions-example)
332
+
333
+ ---
334
+
335
+ Need more help? Check the [complete documentation](index.md) or [open an issue](https://github.com/UnicoVerso/kimu-cli/issues).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kimu-cli",
3
- "version": "1.3.0",
3
+ "version": "1.3.2",
4
4
  "description": "Official command-line interface for the KIMU framework ecosystem - Create, build, and manage KIMU applications with extensible template-based generators",
5
5
  "main": "dist/index.js",
6
6
  "bin": {
@@ -63,7 +63,7 @@
63
63
  "inquirer": "^9.2.12",
64
64
  "ora": "^7.0.1",
65
65
  "semver": "^7.5.4",
66
- "tar": "^6.2.0",
66
+ "tar": "^7.5.7",
67
67
  "validate-npm-package-name": "^5.0.0"
68
68
  },
69
69
  "devDependencies": {
@@ -74,9 +74,9 @@
74
74
  "@types/semver": "^7.5.6",
75
75
  "@types/tar": "^6.1.10",
76
76
  "@types/validate-npm-package-name": "^4.0.2",
77
- "@typescript-eslint/eslint-plugin": "^6.14.0",
78
- "@typescript-eslint/parser": "^6.14.0",
79
- "eslint": "^8.55.0",
77
+ "@typescript-eslint/eslint-plugin": "^6.21.0",
78
+ "@typescript-eslint/parser": "^6.21.0",
79
+ "eslint": "^8.57.0",
80
80
  "eslint-config-prettier": "^9.1.0",
81
81
  "eslint-plugin-prettier": "^5.0.1",
82
82
  "jest": "^29.7.0",