@chatbi-v/cli 1.0.11 → 1.0.13
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 +107 -0
- package/dist/index.js +13065 -1906
- package/package.json +9 -14
- package/templates/app/package.json.hbs +3 -7
- package/templates/app/tsconfig.json.hbs +1 -4
- package/templates/app/vite.config.ts.hbs +12 -0
- package/templates/plugin/package.json.hbs +4 -0
- package/templates/plugin/tsconfig.json.hbs +11 -4
package/README.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# @chatbi-v/cli
|
|
2
|
+
|
|
3
|
+
> ChatBI-V 统一开发工具。基于 **沙箱 (Sandbox)** 与 **零显式依赖 (Zero-Install)** 架构设计，助力开发者快速构建、预览和部署 ChatBI 插件与应用。
|
|
4
|
+
|
|
5
|
+
## 核心理念
|
|
6
|
+
|
|
7
|
+
### 1. 零显式依赖 (Zero-Install)
|
|
8
|
+
开发者在初始化项目后，无需在本地项目 `package.json` 中安装庞大的 `@chatbi-v/core` 或相关内核依赖。CLI 通过虚拟上下文技术，在运行时自动链接到全局沙箱环境，保持项目轻量化。
|
|
9
|
+
|
|
10
|
+
### 2. 全局沙箱 (Global Sandbox)
|
|
11
|
+
内核依赖统一管理在用户根目录下的 `~/.chatbi-v-core` 中。一次安装，多项目共享。支持多版本管理与无缝升级。
|
|
12
|
+
|
|
13
|
+
### 3. CoreKit 驱动
|
|
14
|
+
内置 CoreKit 开发套件，为 App 提供高性能预览服务器，为 Plugin 提供“托管式 Shell”调试环境，确保开发体验与生产环境高度一致。
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 快速开始
|
|
19
|
+
|
|
20
|
+
### 安装 CLI
|
|
21
|
+
```bash
|
|
22
|
+
npm install -g @chatbi-v/cli
|
|
23
|
+
# 或使用 pnpm
|
|
24
|
+
pnpm add -g @chatbi-v/cli
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### 初始化项目
|
|
28
|
+
|
|
29
|
+
#### 创建一个独立应用 (App)
|
|
30
|
+
```bash
|
|
31
|
+
chatbi-cli init my-app --project-type app
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
#### 创建一个插件 (Plugin)
|
|
35
|
+
```bash
|
|
36
|
+
chatbi-cli init my-plugin --project-type plugin
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### 启动开发环境
|
|
40
|
+
进入项目目录后执行：
|
|
41
|
+
```bash
|
|
42
|
+
npm run dev
|
|
43
|
+
# 或者直接使用 cli
|
|
44
|
+
chatbi-cli dev
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## 常用命令
|
|
50
|
+
|
|
51
|
+
| 命令 | 别名 | 描述 |
|
|
52
|
+
| :--- | :--- | :--- |
|
|
53
|
+
| `init` | `i` | 初始化新项目 (App/Plugin/Monorepo) |
|
|
54
|
+
| `dev` | `d` | 启动开发服务器 (支持热更新与沙箱加载) |
|
|
55
|
+
| `build` | `b` | 构建生产环境产物 |
|
|
56
|
+
| `use` | - | 切换使用的内核版本 (项目级或全局 `--global`) |
|
|
57
|
+
| `ls` | - | 列出本地已安装的所有沙箱版本 |
|
|
58
|
+
| `update` | - | 更新或修复全局沙箱内核版本 |
|
|
59
|
+
| `sync` | `s` | 同步内核依赖与虚拟环境 (支持 `-v, --core-version`) |
|
|
60
|
+
| `doctor` | - | 诊断并自动修复项目环境问题 |
|
|
61
|
+
| `bench` | - | 运行 CLI 性能基准测试 |
|
|
62
|
+
| `add` | - | 在 Monorepo 项目中添加新插件 |
|
|
63
|
+
| `gl` | - | 使用 AI 助手生成代码、文档或组件 |
|
|
64
|
+
| `discover` | - | 发现并列出当前工作空间的所有包 |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 高级特性
|
|
69
|
+
|
|
70
|
+
### 版本锁定 (`.chatbi-version`)
|
|
71
|
+
在项目根目录创建一个 `.chatbi-version` 文件，内容为指定的版本号（如 `1.0.11`）。CLI 会优先使用该文件定义的版本，确保团队开发环境的高度一致。
|
|
72
|
+
|
|
73
|
+
### 极速预览
|
|
74
|
+
得益于 **CoreKit 托管容器**，插件项目的冷启动时间通常在 3 秒以内，且支持秒级 HMR 热更新。
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## 性能基准 (Benchmark)
|
|
79
|
+
你可以通过运行 `chatbi-cli bench` 来验证当前环境下的性能表现。
|
|
80
|
+
典型指标：
|
|
81
|
+
- 项目初始化: ≤ 2s
|
|
82
|
+
- 增量编译 (HMR): ≤ 0.5s
|
|
83
|
+
- 核心依赖占用: ≤ 150MB (多项目共享)
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## 常见问题 (FAQ)
|
|
88
|
+
|
|
89
|
+
**Q: 为什么我修改了 `package.json` 但没看到依赖安装？**
|
|
90
|
+
A: 核心依赖由沙箱承载，项目本身是“零依赖”的。如果你需要添加第三方库（如 `lodash`），请正常使用 `npm install`。
|
|
91
|
+
|
|
92
|
+
**Q: 如何更新到最新的内核版本？**
|
|
93
|
+
A: 运行 `chatbi-cli update` 即可自动同步最新的沙箱环境。
|
|
94
|
+
|
|
95
|
+
**Q: 插件模式下如何调试？**
|
|
96
|
+
A: 运行 `dev` 后，访问控制台输出的 Preview URL，即可在模拟的真实容器中实时调试你的插件。
|
|
97
|
+
|
|
98
|
+
## 更多文档
|
|
99
|
+
|
|
100
|
+
- [核心架构与沙箱机制](../../docs/cli/architecture.md)
|
|
101
|
+
- [命令详解与流程图](../../docs/cli/commands.md)
|
|
102
|
+
- [开发与贡献指南](../../docs/cli/development.md)
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## 许可证
|
|
107
|
+
MIT License @ 2025 ChatBI-V Team
|