kimu-cli 1.3.0 → 1.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.
package/LICENSE ADDED
@@ -0,0 +1,17 @@
1
+ # Licenses of KIMU CLI
2
+
3
+ ## Mozilla Public License Version 2.0
4
+
5
+ KIMU is licensed under the **Mozilla Public License, Version 2.0 (MPL-2.0)**.
6
+
7
+ This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
8
+ You can redistribute and/or modify this software under the terms of the Mozilla Public License v. 2.0 (MPL-2.0).
9
+
10
+ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11
+
12
+ You may read the full license text in the file [`MPL-2.0.txt`](./MPL-2.0.txt),
13
+ or online at: [https://www.mozilla.org/MPL/2.0/](https://www.mozilla.org/MPL/2.0/)
14
+
15
+ See also [NOTICE](NOTICE) for attribution and trademark details.
16
+
17
+ Copyright - © 2024–2025 Marco Di Pasquale (UnicòVerso)
package/README.md CHANGED
@@ -1,302 +1,302 @@
1
- # KIMU-CLI
2
-
3
- Official command-line interface for the KIMU framework ecosystem.
4
-
5
- [![npm version](https://badge.fury.io/js/kimu-cli.svg)](https://badge.fury.io/js/kimu-cli)
6
- [![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
7
- [![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org)
8
-
9
- ## Installation
10
-
11
- ### Global Installation (Recommended)
12
-
13
- Install globally to use `kimu` command anywhere:
14
-
15
- ```bash
16
- npm install -g kimu-cli
17
- ```
18
-
19
- ### Verify Installation
20
-
21
- ```bash
22
- kimu --version
23
- kimu --help
24
- ```
25
-
26
- ### Alternative: Use with npx
27
-
28
- Run without installation:
29
-
30
- ```bash
31
- npx kimu-cli create my-app
32
- ```
33
-
34
- ## Quick Start
35
-
36
- Create a new KIMU application:
37
-
38
- ```bash
39
- # Create a new project
40
- kimu create my-app
41
-
42
- # Navigate to project
43
- cd my-app
44
-
45
- # Start development server
46
- npm run dev
47
- ```
48
-
49
- Your application will be available at `http://localhost:5173/`
50
-
51
- ## Features
52
-
53
- - 🚀 **Project Creation**: Create new KIMU applications from templates with `kimu create`
54
- - 🎨 **Component Generation**: Extensible template-based system with `kimu new`
55
- - 🔌 **Custom Generators**: Add new component types via JSON configuration
56
- - 📦 **Module Management**: Install and manage modules from kimu-modules registry (mock, real registry coming soon)
57
- - 🧩 **Extension Management**: Install and manage UI extensions (mock, real registry coming soon)
58
- - 📋 **Package Discovery**: List and browse available modules and extensions
59
- - 🔧 **Build Tools**: Build and serve KIMU applications with optimization (planned)
60
- - 🔍 **Diagnostics**: Project health checks and compatibility validation (planned)
61
-
62
- ## Current Status
63
-
64
- ✅ **Available Commands:**
65
- - `kimu create` - Create new KIMU projects from npm package
66
- - `kimu new <type> <name>` - Generate components from templates (extension, module, etc.)
67
- - `kimu new:list` - List all available component generators
68
- - `kimu install module <name>` - Install KIMU modules (mock, real registry coming soon)
69
- - `kimu install extension <name>` - Install KIMU extensions (mock, real registry coming soon)
70
- - `kimu list modules/extensions/installed` - Browse and discover packages
71
- - `kimu info` - Show project information
72
- - `kimu version` - Show version information
73
- - `kimu help` - Command help system
74
-
75
- ⏳ **Planned Commands:**
76
- - `kimu remove` - Package removal
77
- - `kimu dev/build/serve` - Development workflow
78
- - `kimu doctor` - Project diagnostics
79
-
80
-
81
- ## Author
82
-
83
- **Marco Di Pasquale**
84
- Collettivo [UnicòVerso](https://unicoverso.org)
85
- Progetto [KIMU Framework](https://github.com/UnicoVerso/kimu)
86
-
87
- Per la lista completa degli autori e collaboratori, vedi [AUTHORS.md](AUTHORS.md).
88
-
89
- Per contatti, suggerimenti o collaborazioni: [GitHub @marcodipasquale](https://github.com/marcodipasquale)
90
-
91
- ## Contributions
92
-
93
- Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
94
- If you use KIMU-CLI or want to improve it, open an issue or a pull request.
95
-
96
- ## References & Useful Links
97
-
98
- - [KIMU Framework](https://github.com/UnicoVerso/kimu)
99
- - [KIMU Core](https://github.com/UnicoVerso/kimu-core)
100
- - [KIMU Modules](https://github.com/UnicoVerso/kimu-modules)
101
- - [KIMU Extensions](https://github.com/UnicoVerso/kimu-extensions)
102
- - [Documentation online](https://unicoverso.com/kimu/docs)
103
- - [UnicòVerso](https://unicoverso.org)
104
-
105
- - [📖 Complete Documentation Index](docs/index.md)
106
- - [Intro to KIMU-CLI](docs/intro.md)
107
- - [Command Reference: kimu](docs/command-kimu.md)
108
- - [Distribution & Installation Guide](docs/distribution.md)
109
-
110
-
111
- ### Available Commands
112
- - [Command: create](docs/commands/create.md)
113
- - [Command: new](docs/commands/new.md) - **Extensible template-based generator system**
114
- - [Command: install](docs/commands/install.md) ✅ - **Install modules and extensions**
115
- - [Command: list](docs/commands/list.md) ✅ - **Browse and discover packages**
116
- - [Command: info](docs/commands/info.md)
117
- - [Command: help](docs/commands/help.md)
118
- - [Command: version](docs/commands/version.md)
119
-
120
- ### Planned Commands
121
- - [Command: remove](docs/commands/remove.md) ⏳
122
- - [Command: list](docs/commands/list.md) ⏳
123
- - [Command: build](docs/commands/build.md) ⏳
124
- - [Command: dev](docs/commands/dev.md) ⏳
125
- - [Command: serve](docs/commands/serve.md) ⏳
126
- - [Command: doctor](docs/commands/doctor.md) ⏳
127
-
128
- ## Installation
129
-
130
- ### Global Installation (Recommended)
131
- ```bash
132
- npm install -g kimu-cli
133
- ```
134
-
135
- ### Local Installation
136
- ```bash
137
- npm install --save-dev kimu-cli
138
- ```
139
-
140
- ## Quick Start
141
-
142
- ### Create a New KIMU Project
143
- ```bash
144
- # Create a basic KIMU application
145
- kimu create my-app
146
-
147
- # Create with git initialization
148
- kimu create my-dashboard --git
149
-
150
- # Create and force overwrite if directory exists
151
- kimu create my-app --force
152
- ```
153
-
154
- ### Project Information
155
- ```bash
156
- # Show project info
157
- kimu info
158
-
159
- # Show detailed information
160
- kimu info --verbose
161
-
162
- # JSON output for automation
163
- kimu info --json
164
- ```
165
-
166
- ### Version Information
167
- ```bash
168
- # Show CLI version
169
- kimu version
170
-
171
- # Show detailed version info
172
- kimu version --verbose
173
- ```
174
-
175
- ### Get Help
176
- ```bash
177
- # Show all available commands
178
- kimu help
179
-
180
- # Show help for specific command
181
- kimu help create
182
- kimu create --help
183
- ```
184
-
185
- ## Commands
186
-
187
- ### ✅ Available Commands
188
- - `kimu create <name>` - Create a new KIMU project with basic structure
189
- - `kimu new <type> <name>` - Generate components from templates (extension, module, etc.)
190
- - `kimu new:list` - List all available component generators
191
- - `kimu info` - Show information about the current KIMU project
192
- - `kimu version` - Show KIMU-CLI version and system information
193
- - `kimu help` - Show help for all commands or specific command
194
-
195
- ### ⏳ Planned Commands (Coming Soon)
196
- - `kimu install <name>` - Install modules and extensions
197
- - `kimu remove <name>` - Remove modules and extensions
198
- - `kimu list [type]` - List available or installed packages
199
- - `kimu dev` - Start development server with hot reload
200
- - `kimu build` - Build project for production
201
- - `kimu serve` - Serve built project for testing
202
- - `kimu doctor` - Run project health diagnostics
203
- - `kimu install module <name>` - Install a module
204
- - `kimu remove <name>` - Remove a module or extension
205
- - `kimu list modules` - List available modules
206
- - `kimu list installed` - List installed packages
207
-
208
- ### Project Operations
209
- - `kimu build` - Build the project
210
- - `kimu dev` - Start development server
211
- - `kimu serve` - Serve built project
212
-
213
- ### Information & Diagnostics
214
- - `kimu info` - Show project information
215
- - `kimu doctor` - Run diagnostics
216
- - `kimu version` - Show version information
217
-
218
- ## Project Structure
219
-
220
- ```
221
- my-kimu-app/
222
- ├── src/
223
- │ ├── main.ts # Application entry point
224
- │ ├── app.ts # Main application component
225
- │ └── components/ # Custom components
226
- ├── public/ # Static assets
227
- ├── dist/ # Built files
228
- ├── package.json # NPM configuration
229
- ├── kimu.config.json # KIMU project configuration
230
- ├── tsconfig.json # TypeScript configuration
231
- └── vite.config.ts # Build configuration
232
- ```
233
-
234
- ## Configuration
235
-
236
- ### kimu.config.json
237
- ```json
238
- {
239
- "name": "my-kimu-app",
240
- "version": "1.0.0",
241
- "kimuCore": "^1.0.0",
242
- "template": "basic",
243
- "modules": {
244
- "installed": ["router", "i18n"],
245
- "registry": "https://github.com/unicoverso/kimu-modules"
246
- },
247
- "extensions": {
248
- "installed": ["app-root"],
249
- "main": "app-root"
250
- }
251
- }
252
- ```
253
-
254
- ## Development
255
-
256
- ### Requirements
257
- - Node.js >= 18.0.0
258
- - npm >= 8.0.0
259
-
260
- ### Local Development
261
- ```bash
262
- git clone https://github.com/UnicoVerso/kimu-cli.git
263
- cd kimu-cli
264
- npm install
265
- npm run build
266
- npm link
267
- ```
268
-
269
- ### Testing
270
- ```bash
271
- npm test # Run tests
272
- npm run test:watch # Watch mode
273
- npm run test:coverage # With coverage
274
- ```
275
-
276
- ### Code Quality
277
- ```bash
278
- npm run lint # Check code quality
279
- npm run lint:fix # Fix linting issues
280
- npm run format # Format code
281
- ```
282
-
283
- ## Contributing
284
-
285
- We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
286
-
287
- ## License
288
-
289
- This project is licensed under the Mozilla Public License 2.0 - see the [LICENSE](LICENSE) file for details.
290
-
291
- ## Links
292
-
293
- - [KIMU Framework](https://github.com/UnicoVerso/kimu)
294
- - [KIMU Core](https://github.com/UnicoVerso/kimu-core)
295
- - [KIMU Modules](https://github.com/UnicoVerso/kimu-modules)
296
- - [Documentation online](https://unicoverso.com/kimu/docs)
297
-
298
- ## Support
299
-
300
- - 📖 [Documentation repository](https://github.com/UnicoVerso/kimu-docs)
301
- - 🐛 [Issue Tracker](https://github.com/UnicoVerso/kimu-cli/issues)
302
- - 💬 [Discussions](https://github.com/UnicoVerso/kimu-cli/discussions)
1
+ # KIMU-CLI
2
+
3
+ Official command-line interface for the KIMU framework ecosystem.
4
+
5
+ [![npm version](https://badge.fury.io/js/kimu-cli.svg)](https://badge.fury.io/js/kimu-cli)
6
+ [![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
7
+ [![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org)
8
+
9
+ ## Installation
10
+
11
+ ### Global Installation (Recommended)
12
+
13
+ Install globally to use `kimu` command anywhere:
14
+
15
+ ```bash
16
+ npm install -g kimu-cli
17
+ ```
18
+
19
+ ### Verify Installation
20
+
21
+ ```bash
22
+ kimu --version
23
+ kimu --help
24
+ ```
25
+
26
+ ### Alternative: Use with npx
27
+
28
+ Run without installation:
29
+
30
+ ```bash
31
+ npx kimu-cli create my-app
32
+ ```
33
+
34
+ ## Quick Start
35
+
36
+ Create a new KIMU application:
37
+
38
+ ```bash
39
+ # Create a new project
40
+ kimu create my-app
41
+
42
+ # Navigate to project
43
+ cd my-app
44
+
45
+ # Start development server
46
+ npm run dev
47
+ ```
48
+
49
+ Your application will be available at `http://localhost:5173/`
50
+
51
+ ## Features
52
+
53
+ - 🚀 **Project Creation**: Create new KIMU applications from templates with `kimu create`
54
+ - 🎨 **Component Generation**: Extensible template-based system with `kimu new`
55
+ - 🔌 **Custom Generators**: Add new component types via JSON configuration
56
+ - 📦 **Module Management**: Install and manage modules from kimu-modules registry (mock, real registry coming soon)
57
+ - 🧩 **Extension Management**: Install and manage UI extensions (mock, real registry coming soon)
58
+ - 📋 **Package Discovery**: List and browse available modules and extensions
59
+ - 🔧 **Build Tools**: Build and serve KIMU applications with optimization (planned)
60
+ - 🔍 **Diagnostics**: Project health checks and compatibility validation (planned)
61
+
62
+ ## Current Status
63
+
64
+ ✅ **Available Commands:**
65
+ - `kimu create` - Create new KIMU projects from npm package
66
+ - `kimu new <type> <name>` - Generate components from templates (extension, module, etc.)
67
+ - `kimu new:list` - List all available component generators
68
+ - `kimu install module <name>` - Install KIMU modules (mock, real registry coming soon)
69
+ - `kimu install extension <name>` - Install KIMU extensions (mock, real registry coming soon)
70
+ - `kimu list modules/extensions/installed` - Browse and discover packages
71
+ - `kimu info` - Show project information
72
+ - `kimu version` - Show version information
73
+ - `kimu help` - Command help system
74
+
75
+ ⏳ **Planned Commands:**
76
+ - `kimu remove` - Package removal
77
+ - `kimu dev/build/serve` - Development workflow
78
+ - `kimu doctor` - Project diagnostics
79
+
80
+
81
+ ## Author
82
+
83
+ **Marco Di Pasquale**
84
+ Collettivo [UnicòVerso](https://unicoverso.org)
85
+ Progetto [KIMU Framework](https://github.com/UnicoVerso/kimu)
86
+
87
+ Per la lista completa degli autori e collaboratori, vedi [AUTHORS.md](AUTHORS.md).
88
+
89
+ Per contatti, suggerimenti o collaborazioni: [GitHub @marcodipasquale](https://github.com/marcodipasquale)
90
+
91
+ ## Contributions
92
+
93
+ Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
94
+ If you use KIMU-CLI or want to improve it, open an issue or a pull request.
95
+
96
+ ## References & Useful Links
97
+
98
+ - [KIMU Framework](https://github.com/UnicoVerso/kimu)
99
+ - [KIMU Core](https://github.com/UnicoVerso/kimu-core)
100
+ - [KIMU Modules](https://github.com/UnicoVerso/kimu-modules)
101
+ - [KIMU Extensions](https://github.com/UnicoVerso/kimu-extensions)
102
+ - [Documentation online](https://unicoverso.com/kimu/docs)
103
+ - [UnicòVerso](https://unicoverso.org)
104
+
105
+ - [📖 Complete Documentation Index](docs/index.md)
106
+ - [Intro to KIMU-CLI](docs/intro.md)
107
+ - [Command Reference: kimu](docs/command-kimu.md)
108
+ - [Distribution & Installation Guide](docs/distribution.md)
109
+
110
+
111
+ ### Available Commands
112
+ - [Command: create](docs/commands/create.md)
113
+ - [Command: new](docs/commands/new.md) - **Extensible template-based generator system**
114
+ - [Command: install](docs/commands/install.md) ✅ - **Install modules and extensions**
115
+ - [Command: list](docs/commands/list.md) ✅ - **Browse and discover packages**
116
+ - [Command: info](docs/commands/info.md)
117
+ - [Command: help](docs/commands/help.md)
118
+ - [Command: version](docs/commands/version.md)
119
+
120
+ ### Planned Commands
121
+ - [Command: remove](docs/commands/remove.md) ⏳
122
+ - [Command: list](docs/commands/list.md) ⏳
123
+ - [Command: build](docs/commands/build.md) ⏳
124
+ - [Command: dev](docs/commands/dev.md) ⏳
125
+ - [Command: serve](docs/commands/serve.md) ⏳
126
+ - [Command: doctor](docs/commands/doctor.md) ⏳
127
+
128
+ ## Installation
129
+
130
+ ### Global Installation (Recommended)
131
+ ```bash
132
+ npm install -g kimu-cli
133
+ ```
134
+
135
+ ### Local Installation
136
+ ```bash
137
+ npm install --save-dev kimu-cli
138
+ ```
139
+
140
+ ## Quick Start
141
+
142
+ ### Create a New KIMU Project
143
+ ```bash
144
+ # Create a basic KIMU application
145
+ kimu create my-app
146
+
147
+ # Create with git initialization
148
+ kimu create my-dashboard --git
149
+
150
+ # Create and force overwrite if directory exists
151
+ kimu create my-app --force
152
+ ```
153
+
154
+ ### Project Information
155
+ ```bash
156
+ # Show project info
157
+ kimu info
158
+
159
+ # Show detailed information
160
+ kimu info --verbose
161
+
162
+ # JSON output for automation
163
+ kimu info --json
164
+ ```
165
+
166
+ ### Version Information
167
+ ```bash
168
+ # Show CLI version
169
+ kimu version
170
+
171
+ # Show detailed version info
172
+ kimu version --verbose
173
+ ```
174
+
175
+ ### Get Help
176
+ ```bash
177
+ # Show all available commands
178
+ kimu help
179
+
180
+ # Show help for specific command
181
+ kimu help create
182
+ kimu create --help
183
+ ```
184
+
185
+ ## Commands
186
+
187
+ ### ✅ Available Commands
188
+ - `kimu create <name>` - Create a new KIMU project with basic structure
189
+ - `kimu new <type> <name>` - Generate components from templates (extension, module, etc.)
190
+ - `kimu new:list` - List all available component generators
191
+ - `kimu info` - Show information about the current KIMU project
192
+ - `kimu version` - Show KIMU-CLI version and system information
193
+ - `kimu help` - Show help for all commands or specific command
194
+
195
+ ### ⏳ Planned Commands (Coming Soon)
196
+ - `kimu install <name>` - Install modules and extensions
197
+ - `kimu remove <name>` - Remove modules and extensions
198
+ - `kimu list [type]` - List available or installed packages
199
+ - `kimu dev` - Start development server with hot reload
200
+ - `kimu build` - Build project for production
201
+ - `kimu serve` - Serve built project for testing
202
+ - `kimu doctor` - Run project health diagnostics
203
+ - `kimu install module <name>` - Install a module
204
+ - `kimu remove <name>` - Remove a module or extension
205
+ - `kimu list modules` - List available modules
206
+ - `kimu list installed` - List installed packages
207
+
208
+ ### Project Operations
209
+ - `kimu build` - Build the project
210
+ - `kimu dev` - Start development server
211
+ - `kimu serve` - Serve built project
212
+
213
+ ### Information & Diagnostics
214
+ - `kimu info` - Show project information
215
+ - `kimu doctor` - Run diagnostics
216
+ - `kimu version` - Show version information
217
+
218
+ ## Project Structure
219
+
220
+ ```
221
+ my-kimu-app/
222
+ ├── src/
223
+ │ ├── main.ts # Application entry point
224
+ │ ├── app.ts # Main application component
225
+ │ └── components/ # Custom components
226
+ ├── public/ # Static assets
227
+ ├── dist/ # Built files
228
+ ├── package.json # NPM configuration
229
+ ├── kimu.config.json # KIMU project configuration
230
+ ├── tsconfig.json # TypeScript configuration
231
+ └── vite.config.ts # Build configuration
232
+ ```
233
+
234
+ ## Configuration
235
+
236
+ ### kimu.config.json
237
+ ```json
238
+ {
239
+ "name": "my-kimu-app",
240
+ "version": "1.0.0",
241
+ "kimuCore": "^1.0.0",
242
+ "template": "basic",
243
+ "modules": {
244
+ "installed": ["router", "i18n"],
245
+ "registry": "https://github.com/unicoverso/kimu-modules"
246
+ },
247
+ "extensions": {
248
+ "installed": ["app-root"],
249
+ "main": "app-root"
250
+ }
251
+ }
252
+ ```
253
+
254
+ ## Development
255
+
256
+ ### Requirements
257
+ - Node.js >= 18.0.0
258
+ - npm >= 8.0.0
259
+
260
+ ### Local Development
261
+ ```bash
262
+ git clone https://github.com/UnicoVerso/kimu-cli.git
263
+ cd kimu-cli
264
+ npm install
265
+ npm run build
266
+ npm link
267
+ ```
268
+
269
+ ### Testing
270
+ ```bash
271
+ npm test # Run tests
272
+ npm run test:watch # Watch mode
273
+ npm run test:coverage # With coverage
274
+ ```
275
+
276
+ ### Code Quality
277
+ ```bash
278
+ npm run lint # Check code quality
279
+ npm run lint:fix # Fix linting issues
280
+ npm run format # Format code
281
+ ```
282
+
283
+ ## Contributing
284
+
285
+ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
286
+
287
+ ## License
288
+
289
+ This project is licensed under the Mozilla Public License 2.0 - see the [LICENSE](LICENSE) file for details.
290
+
291
+ ## Links
292
+
293
+ - [KIMU Framework](https://github.com/UnicoVerso/kimu)
294
+ - [KIMU Core](https://github.com/UnicoVerso/kimu-core)
295
+ - [KIMU Modules](https://github.com/UnicoVerso/kimu-modules)
296
+ - [Documentation online](https://unicoverso.com/kimu/docs)
297
+
298
+ ## Support
299
+
300
+ - 📖 [Documentation repository](https://github.com/UnicoVerso/kimu-docs)
301
+ - 🐛 [Issue Tracker](https://github.com/UnicoVerso/kimu-cli/issues)
302
+ - 💬 [Discussions](https://github.com/UnicoVerso/kimu-cli/discussions)