kimu-cli 0.1.0
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/CHANGELOG.md +38 -0
- package/README.md +291 -0
- package/bin/kimu.js +48 -0
- package/dist/commands/create.d.ts +3 -0
- package/dist/commands/create.d.ts.map +1 -0
- package/dist/commands/create.js +115 -0
- package/dist/commands/create.js.map +1 -0
- package/dist/commands/help.d.ts +3 -0
- package/dist/commands/help.d.ts.map +1 -0
- package/dist/commands/help.js +20 -0
- package/dist/commands/help.js.map +1 -0
- package/dist/commands/info.d.ts +9 -0
- package/dist/commands/info.d.ts.map +1 -0
- package/dist/commands/info.js +149 -0
- package/dist/commands/info.js.map +1 -0
- package/dist/commands/version.d.ts +9 -0
- package/dist/commands/version.d.ts.map +1 -0
- package/dist/commands/version.js +45 -0
- package/dist/commands/version.js.map +1 -0
- package/dist/config/constants.d.ts +50 -0
- package/dist/config/constants.d.ts.map +1 -0
- package/dist/config/constants.js +61 -0
- package/dist/config/constants.js.map +1 -0
- package/dist/config/defaults.d.ts +59 -0
- package/dist/config/defaults.d.ts.map +1 -0
- package/dist/config/defaults.js +127 -0
- package/dist/config/defaults.js.map +1 -0
- package/dist/index.d.ts +12 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +28 -0
- package/dist/index.js.map +1 -0
- package/dist/types/cli-types.d.ts +55 -0
- package/dist/types/cli-types.d.ts.map +1 -0
- package/dist/types/cli-types.js +6 -0
- package/dist/types/cli-types.js.map +1 -0
- package/dist/types/project-types.d.ts +79 -0
- package/dist/types/project-types.d.ts.map +1 -0
- package/dist/types/project-types.js +6 -0
- package/dist/types/project-types.js.map +1 -0
- package/dist/types/registry-types.d.ts +87 -0
- package/dist/types/registry-types.d.ts.map +1 -0
- package/dist/types/registry-types.js +6 -0
- package/dist/types/registry-types.js.map +1 -0
- package/dist/utils/logger.d.ts +39 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +115 -0
- package/dist/utils/logger.js.map +1 -0
- package/docs/command-kimu-new.md +207 -0
- package/docs/command-kimu-old.md +51 -0
- package/docs/command-kimu.md +207 -0
- package/docs/commands/build.md +82 -0
- package/docs/commands/create.md +58 -0
- package/docs/commands/dev.md +87 -0
- package/docs/commands/doctor.md +129 -0
- package/docs/commands/help.md +37 -0
- package/docs/commands/info.md +46 -0
- package/docs/commands/install.md +67 -0
- package/docs/commands/list.md +85 -0
- package/docs/commands/remove.md +67 -0
- package/docs/commands/serve.md +91 -0
- package/docs/commands/version.md +31 -0
- package/docs/distribution.md +93 -0
- package/docs/index.md +127 -0
- package/docs/intro.md +86 -0
- package/package.json +101 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli-types.js","sourceRoot":"","sources":["../../src/types/cli-types.ts"],"names":[],"mappings":";AAAA;;GAEG"}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Project configuration types for KIMU projects
|
|
3
|
+
*/
|
|
4
|
+
export interface KimuConfig {
|
|
5
|
+
name: string;
|
|
6
|
+
version: string;
|
|
7
|
+
kimuCore: string;
|
|
8
|
+
template: string;
|
|
9
|
+
modules: ModuleConfiguration;
|
|
10
|
+
extensions: ExtensionConfiguration;
|
|
11
|
+
build: BuildConfiguration;
|
|
12
|
+
development: DevelopmentConfiguration;
|
|
13
|
+
}
|
|
14
|
+
export interface ModuleConfiguration {
|
|
15
|
+
installed: string[];
|
|
16
|
+
registry: string;
|
|
17
|
+
dependencies: Record<string, string>;
|
|
18
|
+
}
|
|
19
|
+
export interface ExtensionConfiguration {
|
|
20
|
+
installed: string[];
|
|
21
|
+
main: string;
|
|
22
|
+
dependencies: Record<string, string>;
|
|
23
|
+
}
|
|
24
|
+
export interface BuildConfiguration {
|
|
25
|
+
target: string;
|
|
26
|
+
format: 'esm' | 'iife' | 'cjs';
|
|
27
|
+
sourcemap: boolean;
|
|
28
|
+
minify: boolean;
|
|
29
|
+
outDir?: string;
|
|
30
|
+
publicPath?: string;
|
|
31
|
+
}
|
|
32
|
+
export interface DevelopmentConfiguration {
|
|
33
|
+
port: number;
|
|
34
|
+
host: string;
|
|
35
|
+
open: boolean;
|
|
36
|
+
hmr?: boolean;
|
|
37
|
+
https?: boolean;
|
|
38
|
+
}
|
|
39
|
+
export interface ProjectStructure {
|
|
40
|
+
[path: string]: string[] | ProjectStructure;
|
|
41
|
+
}
|
|
42
|
+
export interface PackageScripts {
|
|
43
|
+
[scriptName: string]: string;
|
|
44
|
+
}
|
|
45
|
+
export interface KimuProjectTemplate {
|
|
46
|
+
name: string;
|
|
47
|
+
kimuCoreVersion: string;
|
|
48
|
+
defaultModules: string[];
|
|
49
|
+
structure: ProjectStructure;
|
|
50
|
+
scripts: PackageScripts;
|
|
51
|
+
description?: string;
|
|
52
|
+
author?: string;
|
|
53
|
+
}
|
|
54
|
+
export interface VersionCompatibility {
|
|
55
|
+
kimuCli: string;
|
|
56
|
+
kimuCore: {
|
|
57
|
+
required: string;
|
|
58
|
+
installed?: string;
|
|
59
|
+
compatible: boolean;
|
|
60
|
+
};
|
|
61
|
+
modules: {
|
|
62
|
+
[name: string]: {
|
|
63
|
+
required: string;
|
|
64
|
+
installed: string;
|
|
65
|
+
compatible: boolean;
|
|
66
|
+
};
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
export interface ProjectInfo {
|
|
70
|
+
name: string;
|
|
71
|
+
version: string;
|
|
72
|
+
kimuCore: string;
|
|
73
|
+
modules: string[];
|
|
74
|
+
extensions: string[];
|
|
75
|
+
template: string;
|
|
76
|
+
isValid: boolean;
|
|
77
|
+
compatibility: VersionCompatibility;
|
|
78
|
+
}
|
|
79
|
+
//# sourceMappingURL=project-types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"project-types.d.ts","sourceRoot":"","sources":["../../src/types/project-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,UAAU,EAAE,sBAAsB,CAAC;IACnC,KAAK,EAAE,kBAAkB,CAAC;IAC1B,WAAW,EAAE,wBAAwB,CAAC;CACvC;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;IAC/B,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,gBAAgB,CAAC;CAC7C;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,OAAO,EAAE,cAAc,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE;QACR,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;IACF,OAAO,EAAE;QACP,CAAC,IAAI,EAAE,MAAM,GAAG;YACd,QAAQ,EAAE,MAAM,CAAC;YACjB,SAAS,EAAE,MAAM,CAAC;YAClB,UAAU,EAAE,OAAO,CAAC;SACrB,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,oBAAoB,CAAC;CACrC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"project-types.js","sourceRoot":"","sources":["../../src/types/project-types.ts"],"names":[],"mappings":";AAAA;;GAEG"}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Registry and module types for KIMU ecosystem
|
|
3
|
+
*/
|
|
4
|
+
export interface ModuleCatalog {
|
|
5
|
+
version: string;
|
|
6
|
+
lastUpdated: string;
|
|
7
|
+
modules: Record<string, ModuleInfo>;
|
|
8
|
+
extensions: Record<string, ExtensionInfo>;
|
|
9
|
+
}
|
|
10
|
+
export interface ModuleInfo {
|
|
11
|
+
name: string;
|
|
12
|
+
version: string;
|
|
13
|
+
description: string;
|
|
14
|
+
author: string;
|
|
15
|
+
repository: string;
|
|
16
|
+
homepage?: string;
|
|
17
|
+
license: string;
|
|
18
|
+
keywords: string[];
|
|
19
|
+
dependencies: string[];
|
|
20
|
+
kimuCore: string;
|
|
21
|
+
size: {
|
|
22
|
+
minified: number;
|
|
23
|
+
gzipped: number;
|
|
24
|
+
};
|
|
25
|
+
downloadUrl: string;
|
|
26
|
+
checksums: {
|
|
27
|
+
sha256: string;
|
|
28
|
+
md5: string;
|
|
29
|
+
};
|
|
30
|
+
createdAt: string;
|
|
31
|
+
updatedAt: string;
|
|
32
|
+
}
|
|
33
|
+
export interface ExtensionInfo {
|
|
34
|
+
name: string;
|
|
35
|
+
version: string;
|
|
36
|
+
description: string;
|
|
37
|
+
author: string;
|
|
38
|
+
repository: string;
|
|
39
|
+
homepage?: string;
|
|
40
|
+
license: string;
|
|
41
|
+
keywords: string[];
|
|
42
|
+
dependencies: string[];
|
|
43
|
+
kimuCore: string;
|
|
44
|
+
category: string;
|
|
45
|
+
icon?: string;
|
|
46
|
+
screenshots?: string[];
|
|
47
|
+
size: {
|
|
48
|
+
minified: number;
|
|
49
|
+
gzipped: number;
|
|
50
|
+
};
|
|
51
|
+
downloadUrl: string;
|
|
52
|
+
checksums: {
|
|
53
|
+
sha256: string;
|
|
54
|
+
md5: string;
|
|
55
|
+
};
|
|
56
|
+
createdAt: string;
|
|
57
|
+
updatedAt: string;
|
|
58
|
+
}
|
|
59
|
+
export interface RegistryConfig {
|
|
60
|
+
url: string;
|
|
61
|
+
timeout: number;
|
|
62
|
+
retries: number;
|
|
63
|
+
cacheDir: string;
|
|
64
|
+
cacheTtl: number;
|
|
65
|
+
}
|
|
66
|
+
export interface DownloadProgress {
|
|
67
|
+
total: number;
|
|
68
|
+
downloaded: number;
|
|
69
|
+
percentage: number;
|
|
70
|
+
speed: number;
|
|
71
|
+
eta: number;
|
|
72
|
+
}
|
|
73
|
+
export interface InstallResult {
|
|
74
|
+
success: boolean;
|
|
75
|
+
module: string;
|
|
76
|
+
version: string;
|
|
77
|
+
dependencies: string[];
|
|
78
|
+
errors?: string[];
|
|
79
|
+
warnings?: string[];
|
|
80
|
+
}
|
|
81
|
+
export interface RegistryResponse<T> {
|
|
82
|
+
success: boolean;
|
|
83
|
+
data?: T;
|
|
84
|
+
error?: string;
|
|
85
|
+
timestamp: string;
|
|
86
|
+
}
|
|
87
|
+
//# sourceMappingURL=registry-types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registry-types.d.ts","sourceRoot":"","sources":["../../src/types/registry-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE;QACT,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE;QACT,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registry-types.js","sourceRoot":"","sources":["../../src/types/registry-types.ts"],"names":[],"mappings":";AAAA;;GAEG"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Consistent logging utility for KIMU-CLI
|
|
3
|
+
*/
|
|
4
|
+
export declare enum LogLevel {
|
|
5
|
+
ERROR = 0,
|
|
6
|
+
WARN = 1,
|
|
7
|
+
INFO = 2,
|
|
8
|
+
SUCCESS = 3,
|
|
9
|
+
DEBUG = 4
|
|
10
|
+
}
|
|
11
|
+
export declare class Logger {
|
|
12
|
+
private verbose;
|
|
13
|
+
private level;
|
|
14
|
+
constructor(verbose?: boolean, level?: LogLevel);
|
|
15
|
+
setVerbose(verbose: boolean): void;
|
|
16
|
+
setLevel(level: LogLevel): void;
|
|
17
|
+
private shouldLog;
|
|
18
|
+
error(message: string, error?: Error): void;
|
|
19
|
+
warn(message: string): void;
|
|
20
|
+
info(message: string): void;
|
|
21
|
+
success(message: string): void;
|
|
22
|
+
debug(message: string, data?: unknown): void;
|
|
23
|
+
log(message: string): void;
|
|
24
|
+
newLine(): void;
|
|
25
|
+
table(data: Record<string, unknown>[]): void;
|
|
26
|
+
json(data: unknown): void;
|
|
27
|
+
command(command: string): void;
|
|
28
|
+
step(step: number, total: number, message: string): void;
|
|
29
|
+
bullet(message: string): void;
|
|
30
|
+
arrow(message: string): void;
|
|
31
|
+
checkmark(message: string): void;
|
|
32
|
+
cross(message: string): void;
|
|
33
|
+
bold(text: string): string;
|
|
34
|
+
dim(text: string): string;
|
|
35
|
+
highlight(text: string): string;
|
|
36
|
+
code(text: string): string;
|
|
37
|
+
path(text: string): string;
|
|
38
|
+
}
|
|
39
|
+
//# sourceMappingURL=logger.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,oBAAY,QAAQ;IAClB,KAAK,IAAI;IACT,IAAI,IAAI;IACR,IAAI,IAAI;IACR,OAAO,IAAI;IACX,KAAK,IAAI;CACV;AAED,qBAAa,MAAM;IACjB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,KAAK,CAAW;gBAEZ,OAAO,UAAQ,EAAE,KAAK,WAAgB;IAKlD,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAIlC,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI;IAI/B,OAAO,CAAC,SAAS;IAIjB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI;IAS3C,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAM3B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAM3B,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAM9B,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI;IAS5C,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI1B,OAAO,IAAI,IAAI;IAIf,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,IAAI;IAI5C,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI;IAKzB,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI9B,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAKxD,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI7B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI5B,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAIhC,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK5B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI1B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAIzB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI/B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI1B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAG3B"}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Consistent logging utility for KIMU-CLI
|
|
4
|
+
*/
|
|
5
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
6
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
7
|
+
};
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.Logger = exports.LogLevel = void 0;
|
|
10
|
+
const chalk_1 = __importDefault(require("chalk"));
|
|
11
|
+
const constants_1 = require("../config/constants");
|
|
12
|
+
var LogLevel;
|
|
13
|
+
(function (LogLevel) {
|
|
14
|
+
LogLevel[LogLevel["ERROR"] = 0] = "ERROR";
|
|
15
|
+
LogLevel[LogLevel["WARN"] = 1] = "WARN";
|
|
16
|
+
LogLevel[LogLevel["INFO"] = 2] = "INFO";
|
|
17
|
+
LogLevel[LogLevel["SUCCESS"] = 3] = "SUCCESS";
|
|
18
|
+
LogLevel[LogLevel["DEBUG"] = 4] = "DEBUG";
|
|
19
|
+
})(LogLevel || (exports.LogLevel = LogLevel = {}));
|
|
20
|
+
class Logger {
|
|
21
|
+
constructor(verbose = false, level = LogLevel.INFO) {
|
|
22
|
+
this.verbose = verbose;
|
|
23
|
+
this.level = level;
|
|
24
|
+
}
|
|
25
|
+
setVerbose(verbose) {
|
|
26
|
+
this.verbose = verbose;
|
|
27
|
+
}
|
|
28
|
+
setLevel(level) {
|
|
29
|
+
this.level = level;
|
|
30
|
+
}
|
|
31
|
+
shouldLog(level) {
|
|
32
|
+
return level <= this.level || (this.verbose && level <= LogLevel.DEBUG);
|
|
33
|
+
}
|
|
34
|
+
error(message, error) {
|
|
35
|
+
if (!this.shouldLog(LogLevel.ERROR))
|
|
36
|
+
return;
|
|
37
|
+
console.error(chalk_1.default.red(`${constants_1.SYMBOLS.ERROR} ${message}`));
|
|
38
|
+
if (error && this.verbose) {
|
|
39
|
+
console.error(chalk_1.default.gray(error.stack || error.message));
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
warn(message) {
|
|
43
|
+
if (!this.shouldLog(LogLevel.WARN))
|
|
44
|
+
return;
|
|
45
|
+
console.warn(chalk_1.default.yellow(`${constants_1.SYMBOLS.WARNING} ${message}`));
|
|
46
|
+
}
|
|
47
|
+
info(message) {
|
|
48
|
+
if (!this.shouldLog(LogLevel.INFO))
|
|
49
|
+
return;
|
|
50
|
+
console.log(chalk_1.default.blue(`${constants_1.SYMBOLS.INFO} ${message}`));
|
|
51
|
+
}
|
|
52
|
+
success(message) {
|
|
53
|
+
if (!this.shouldLog(LogLevel.SUCCESS))
|
|
54
|
+
return;
|
|
55
|
+
console.log(chalk_1.default.green(`${constants_1.SYMBOLS.SUCCESS} ${message}`));
|
|
56
|
+
}
|
|
57
|
+
debug(message, data) {
|
|
58
|
+
if (!this.shouldLog(LogLevel.DEBUG))
|
|
59
|
+
return;
|
|
60
|
+
console.log(chalk_1.default.gray(`[DEBUG] ${message}`));
|
|
61
|
+
if (data && this.verbose) {
|
|
62
|
+
console.log(chalk_1.default.gray(JSON.stringify(data, null, 2)));
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
log(message) {
|
|
66
|
+
console.log(message);
|
|
67
|
+
}
|
|
68
|
+
newLine() {
|
|
69
|
+
console.log();
|
|
70
|
+
}
|
|
71
|
+
table(data) {
|
|
72
|
+
console.table(data);
|
|
73
|
+
}
|
|
74
|
+
json(data) {
|
|
75
|
+
console.log(JSON.stringify(data, null, 2));
|
|
76
|
+
}
|
|
77
|
+
// Utility methods for common patterns
|
|
78
|
+
command(command) {
|
|
79
|
+
console.log(chalk_1.default.dim(`$ ${command}`));
|
|
80
|
+
}
|
|
81
|
+
step(step, total, message) {
|
|
82
|
+
const progress = chalk_1.default.dim(`[${step}/${total}]`);
|
|
83
|
+
console.log(`${progress} ${message}`);
|
|
84
|
+
}
|
|
85
|
+
bullet(message) {
|
|
86
|
+
console.log(` ${constants_1.SYMBOLS.BULLET} ${message}`);
|
|
87
|
+
}
|
|
88
|
+
arrow(message) {
|
|
89
|
+
console.log(` ${constants_1.SYMBOLS.ARROW} ${message}`);
|
|
90
|
+
}
|
|
91
|
+
checkmark(message) {
|
|
92
|
+
console.log(chalk_1.default.green(` ${constants_1.SYMBOLS.CHECKMARK} ${message}`));
|
|
93
|
+
}
|
|
94
|
+
cross(message) {
|
|
95
|
+
console.log(chalk_1.default.red(` ${constants_1.SYMBOLS.CROSS} ${message}`));
|
|
96
|
+
}
|
|
97
|
+
// Format helpers
|
|
98
|
+
bold(text) {
|
|
99
|
+
return chalk_1.default.bold(text);
|
|
100
|
+
}
|
|
101
|
+
dim(text) {
|
|
102
|
+
return chalk_1.default.dim(text);
|
|
103
|
+
}
|
|
104
|
+
highlight(text) {
|
|
105
|
+
return chalk_1.default.cyan(text);
|
|
106
|
+
}
|
|
107
|
+
code(text) {
|
|
108
|
+
return chalk_1.default.gray.inverse(` ${text} `);
|
|
109
|
+
}
|
|
110
|
+
path(text) {
|
|
111
|
+
return chalk_1.default.underline(text);
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
exports.Logger = Logger;
|
|
115
|
+
//# sourceMappingURL=logger.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;AAEH,kDAA0B;AAC1B,mDAA8C;AAE9C,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,yCAAS,CAAA;IACT,uCAAQ,CAAA;IACR,uCAAQ,CAAA;IACR,6CAAW,CAAA;IACX,yCAAS,CAAA;AACX,CAAC,EANW,QAAQ,wBAAR,QAAQ,QAMnB;AAED,MAAa,MAAM;IAIjB,YAAY,OAAO,GAAG,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,IAAI;QAChD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,UAAU,CAAC,OAAgB;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,QAAQ,CAAC,KAAe;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEO,SAAS,CAAC,KAAe;QAC/B,OAAO,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,KAAa;QAClC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO;QAE5C,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,GAAG,mBAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;QACxD,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC1B,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO;QAE3C,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,MAAM,CAAC,GAAG,mBAAO,CAAC,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO;QAE3C,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,mBAAO,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,OAAO;QAE9C,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,GAAG,mBAAO,CAAC,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,IAAc;QACnC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO;QAE5C,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,WAAW,OAAO,EAAE,CAAC,CAAC,CAAC;QAC9C,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED,GAAG,CAAC,OAAe;QACjB,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAED,OAAO;QACL,OAAO,CAAC,GAAG,EAAE,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,IAA+B;QACnC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,IAAa;QAChB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,sCAAsC;IACtC,OAAO,CAAC,OAAe;QACrB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,CAAC,IAAY,EAAE,KAAa,EAAE,OAAe;QAC/C,MAAM,QAAQ,GAAG,eAAK,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC,CAAC;QACjD,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,IAAI,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,OAAe;QACpB,OAAO,CAAC,GAAG,CAAC,KAAK,mBAAO,CAAC,MAAM,IAAI,OAAO,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,OAAe;QACnB,OAAO,CAAC,GAAG,CAAC,KAAK,mBAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,SAAS,CAAC,OAAe;QACvB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,KAAK,mBAAO,CAAC,SAAS,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,OAAe;QACnB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,GAAG,CAAC,KAAK,mBAAO,CAAC,KAAK,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,iBAAiB;IACjB,IAAI,CAAC,IAAY;QACf,OAAO,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,GAAG,CAAC,IAAY;QACd,OAAO,eAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,SAAS,CAAC,IAAY;QACpB,OAAO,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC,IAAY;QACf,OAAO,eAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,CAAC,IAAY;QACf,OAAO,eAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF;AAvHD,wBAuHC"}
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
# The `kimu` Command Reference
|
|
2
|
+
|
|
3
|
+
The `kimu` command is the main entry point for KIMU-CLI and provides access to all framework tools and utilities.
|
|
4
|
+
|
|
5
|
+
## Basic Usage
|
|
6
|
+
```bash
|
|
7
|
+
kimu <command> [options]
|
|
8
|
+
kimu <command> --help
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Global Options
|
|
12
|
+
These options are available for all commands:
|
|
13
|
+
- `--help, -h`: Show help for any command
|
|
14
|
+
- `--verbose`: Enable verbose output for detailed information
|
|
15
|
+
- `--version, -v`: Show KIMU-CLI version
|
|
16
|
+
|
|
17
|
+
## Command Categories
|
|
18
|
+
|
|
19
|
+
### 🚀 Project Management
|
|
20
|
+
| Command | Description | Status |
|
|
21
|
+
|---------|-------------|---------|
|
|
22
|
+
| `create <name>` | Create a new KIMU project | ✅ **Available** |
|
|
23
|
+
| `info` | Show project information and status | ✅ **Available** |
|
|
24
|
+
| `doctor` | Run project health diagnostics | ⏳ **Planned** |
|
|
25
|
+
|
|
26
|
+
### 📦 Package Management
|
|
27
|
+
| Command | Description | Status |
|
|
28
|
+
|---------|-------------|---------|
|
|
29
|
+
| `install <name>` | Install modules and extensions | ⏳ **Planned** |
|
|
30
|
+
| `remove <name>` | Remove modules and extensions | ⏳ **Planned** |
|
|
31
|
+
| `list [type]` | List available/installed packages | ⏳ **Planned** |
|
|
32
|
+
|
|
33
|
+
### 🔧 Development Workflow
|
|
34
|
+
| Command | Description | Status |
|
|
35
|
+
|---------|-------------|---------|
|
|
36
|
+
| `dev` | Start development server | ⏳ **Planned** |
|
|
37
|
+
| `build` | Build project for production | ⏳ **Planned** |
|
|
38
|
+
| `serve` | Serve built project | ⏳ **Planned** |
|
|
39
|
+
|
|
40
|
+
### ℹ️ Utilities
|
|
41
|
+
| Command | Description | Status |
|
|
42
|
+
|---------|-------------|---------|
|
|
43
|
+
| `version` | Show version information | ✅ **Available** |
|
|
44
|
+
| `help [command]` | Show help information | ✅ **Available** |
|
|
45
|
+
|
|
46
|
+
## Available Commands (Current)
|
|
47
|
+
|
|
48
|
+
### Project Creation
|
|
49
|
+
```bash
|
|
50
|
+
# Create a new project
|
|
51
|
+
kimu create my-app
|
|
52
|
+
|
|
53
|
+
# Create with git initialization
|
|
54
|
+
kimu create my-app --git
|
|
55
|
+
|
|
56
|
+
# Force overwrite existing directory
|
|
57
|
+
kimu create my-app --force
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Project Information
|
|
61
|
+
```bash
|
|
62
|
+
# Show basic project info
|
|
63
|
+
kimu info
|
|
64
|
+
|
|
65
|
+
# Show detailed information
|
|
66
|
+
kimu info --verbose
|
|
67
|
+
|
|
68
|
+
# Output in JSON format
|
|
69
|
+
kimu info --json
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Version and Help
|
|
73
|
+
```bash
|
|
74
|
+
# Show CLI version
|
|
75
|
+
kimu version
|
|
76
|
+
|
|
77
|
+
# Show detailed version info
|
|
78
|
+
kimu version --verbose
|
|
79
|
+
|
|
80
|
+
# Show general help
|
|
81
|
+
kimu help
|
|
82
|
+
|
|
83
|
+
# Show help for specific command
|
|
84
|
+
kimu help create
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Planned Commands (Coming Soon)
|
|
88
|
+
|
|
89
|
+
### Module Management
|
|
90
|
+
```bash
|
|
91
|
+
# Install a module
|
|
92
|
+
kimu install module router
|
|
93
|
+
|
|
94
|
+
# Install an extension
|
|
95
|
+
kimu install extension dashboard
|
|
96
|
+
|
|
97
|
+
# Remove a module/extension
|
|
98
|
+
kimu remove router
|
|
99
|
+
|
|
100
|
+
# List available modules
|
|
101
|
+
kimu list modules
|
|
102
|
+
|
|
103
|
+
# List installed packages
|
|
104
|
+
kimu list installed
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Development Tools
|
|
108
|
+
```bash
|
|
109
|
+
# Start development server
|
|
110
|
+
kimu dev --port 3000
|
|
111
|
+
|
|
112
|
+
# Build for production
|
|
113
|
+
kimu build --minify
|
|
114
|
+
|
|
115
|
+
# Serve built project
|
|
116
|
+
kimu serve --port 4000
|
|
117
|
+
|
|
118
|
+
# Run diagnostics
|
|
119
|
+
kimu doctor --fix
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## Command Options Patterns
|
|
123
|
+
|
|
124
|
+
### Common Patterns
|
|
125
|
+
- `--verbose`: Detailed output (available for most commands)
|
|
126
|
+
- `--json`: JSON output format (for automation)
|
|
127
|
+
- `--force`: Skip confirmations and overwrite
|
|
128
|
+
- `--help`: Command-specific help
|
|
129
|
+
|
|
130
|
+
### Development Options
|
|
131
|
+
- `--port <number>`: Server port configuration
|
|
132
|
+
- `--host <string>`: Server host configuration
|
|
133
|
+
- `--open`: Automatically open browser
|
|
134
|
+
- `--watch`: Watch for file changes
|
|
135
|
+
|
|
136
|
+
### Build Options
|
|
137
|
+
- `--mode <mode>`: Build mode (development/production)
|
|
138
|
+
- `--target <target>`: JavaScript target (es2020/es2022/esnext)
|
|
139
|
+
- `--minify`: Enable minification
|
|
140
|
+
- `--sourcemap`: Generate source maps
|
|
141
|
+
|
|
142
|
+
## Examples by Use Case
|
|
143
|
+
|
|
144
|
+
### Starting a New Project
|
|
145
|
+
```bash
|
|
146
|
+
# Basic project setup
|
|
147
|
+
kimu create my-app
|
|
148
|
+
cd my-app
|
|
149
|
+
kimu info # Verify project setup
|
|
150
|
+
|
|
151
|
+
# Development workflow (when implemented)
|
|
152
|
+
kimu dev # Start development server
|
|
153
|
+
kimu build # Build for production
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Working with Modules
|
|
157
|
+
```bash
|
|
158
|
+
# Module management (when implemented)
|
|
159
|
+
kimu list modules # Browse available modules
|
|
160
|
+
kimu install module router # Install a module
|
|
161
|
+
kimu install extension dashboard # Install an extension
|
|
162
|
+
kimu list installed # See what's installed
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### Debugging and Maintenance
|
|
166
|
+
```bash
|
|
167
|
+
# Project health (when implemented)
|
|
168
|
+
kimu doctor # Check project health
|
|
169
|
+
kimu doctor --fix # Auto-fix common issues
|
|
170
|
+
kimu info --verbose # Detailed project info
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## Getting Help
|
|
174
|
+
|
|
175
|
+
### Command-Specific Help
|
|
176
|
+
Every command supports `--help`:
|
|
177
|
+
```bash
|
|
178
|
+
kimu create --help
|
|
179
|
+
kimu info --help
|
|
180
|
+
kimu version --help
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### General Help
|
|
184
|
+
```bash
|
|
185
|
+
kimu help # Show all commands
|
|
186
|
+
kimu help create # Show help for create command
|
|
187
|
+
kimu --help # Alternative syntax
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Verbose Information
|
|
191
|
+
Add `--verbose` to most commands for detailed output:
|
|
192
|
+
```bash
|
|
193
|
+
kimu info --verbose
|
|
194
|
+
kimu version --verbose
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
## Notes
|
|
198
|
+
|
|
199
|
+
- **Current Status**: Basic commands are implemented, advanced features coming soon
|
|
200
|
+
- **Project Context**: Some commands require being run from within a KIMU project directory
|
|
201
|
+
- **Internet Required**: Package management commands require internet connectivity
|
|
202
|
+
- **Node.js**: Requires Node.js >= 18.0.0 and npm >= 8.0.0
|
|
203
|
+
- **Documentation**: Each command has detailed documentation in `docs/commands/`
|
|
204
|
+
|
|
205
|
+
For detailed documentation on each command, see the individual files in the `docs/commands/` directory.
|
|
206
|
+
|
|
207
|
+
---
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# The `kimu` Command
|
|
2
|
+
|
|
3
|
+
The main entry point for KIMU-CLI is the `kimu` command.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
```bash
|
|
7
|
+
kimu <command> [options]
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
## Available Commands
|
|
11
|
+
- `version`: Show version information
|
|
12
|
+
- `help`: Show help for all commands
|
|
13
|
+
- `info`: Show project information
|
|
14
|
+
- `create <name>`: Create a new KIMU project
|
|
15
|
+
- `install module <name>`: Install a module
|
|
16
|
+
- `remove <name>`: Remove a module or extension
|
|
17
|
+
- `list modules`: List available modules
|
|
18
|
+
- `list installed`: List installed packages
|
|
19
|
+
- `build`: Build the project
|
|
20
|
+
- `dev`: Start development server
|
|
21
|
+
- `serve`: Serve built project
|
|
22
|
+
- `doctor`: Run diagnostics
|
|
23
|
+
|
|
24
|
+
> For details and usage examples of each command, see the dedicated documentation in `docs/commands/<command>.md`.
|
|
25
|
+
|
|
26
|
+
## Options
|
|
27
|
+
- `--help`: Show help for any command
|
|
28
|
+
- `--verbose`: Enable verbose output
|
|
29
|
+
- `--json`: Output in JSON format (where supported)
|
|
30
|
+
- `--template <name>`: Specify a template for project creation
|
|
31
|
+
- `--no-install`: Skip npm install during project creation
|
|
32
|
+
|
|
33
|
+
## Examples
|
|
34
|
+
```bash
|
|
35
|
+
# Create a new project
|
|
36
|
+
kimu create my-app
|
|
37
|
+
|
|
38
|
+
# Install a module
|
|
39
|
+
kimu install module router
|
|
40
|
+
|
|
41
|
+
# Show project info in JSON
|
|
42
|
+
kimu info --json
|
|
43
|
+
|
|
44
|
+
# Build the project
|
|
45
|
+
kimu build
|
|
46
|
+
|
|
47
|
+
# Show help for a command
|
|
48
|
+
kimu help
|
|
49
|
+
kimu create --help
|
|
50
|
+
```
|
|
51
|
+
---
|