Skip to content

Commit 623d67b

Browse files
authored
Merge pull request #18 from jiangmuran/opensource
2 parents 22ff537 + e2eb47a commit 623d67b

13 files changed

Lines changed: 4294 additions & 1966 deletions

File tree

README.md

Lines changed: 174 additions & 154 deletions
Large diffs are not rendered by default.

docs/build-workflow.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,18 @@ DeepCode/
2323

2424
### 1. 快速开发构建 / Quick Development Build
2525

26-
**用途 / Purpose**: 日常开发时使用,构建速度快,排除 VS Code 扩展
27-
For daily development with faster build times, excluding VS Code extension
26+
**用途 / Purpose**: 日常开发时使用,按需构建所需模块
27+
For daily development with targeted builds
2828

2929
```bash
3030
# 基础构建 / Basic build
31-
npm run build # 仅构建 core 和 cli / Build only core and cli
31+
npm run build # 构建全部模块 / Build core + cli + vscode-ui-plugin
32+
33+
# 仅构建 CLI / Build CLI only
34+
npm run build:cli # 构建 core + cli / Build core + cli
35+
36+
# 仅构建 VS Code 插件 / Build VS Code plugin only
37+
npm run build:plugin # 构建 vscode-ui-plugin / Build vscode-ui-plugin
3238

3339
# 开发版打包 / Development bundle
3440
npm run bundle:dev # 开发版打包(快速)/ Development bundle (fast)
@@ -161,20 +167,22 @@ npm run env:test
161167
### 日常开发 / Daily Development
162168

163169
1. **开始开发 / Start Development**
170+
164171
```bash
165172
npm run dev # 启动开发模式 / Start development mode
166173
```
167174

168175
2. **代码修改后 / After Code Changes**
169176
```bash
170-
npm run build # 快速构建验证 / Quick build verification
177+
npm run build:cli # CLI 快速构建验证 / Quick CLI build verification
171178
npm run lint # 检查代码质量 / Check code quality
172179
npm test # 运行测试 / Run tests
173180
```
174181

175182
### VS Code 扩展开发 / VS Code Extension Development
176183

177184
1. **准备扩展开发环境 / Prepare Extension Development**
185+
178186
```bash
179187
npm install --workspace=packages/vscode-ui-plugin
180188
```
@@ -188,6 +196,7 @@ npm run env:test
188196
### 发布准备 / Release Preparation
189197

190198
1. **完整构建和测试 / Complete Build and Test**
199+
191200
```bash
192201
npm run preflight # 完整预检 / Complete preflight
193202
npm run build:all # 完整构建 / Complete build
@@ -215,8 +224,8 @@ npm run env:test
215224

216225
### 性能优化 / Performance Optimization
217226

218-
-**默认构建排除 VS Code 扩展以提升速度** / Default build excludes VS Code extension for speed
219-
- 🎨 **需要完整功能时使用 `INCLUDE_VSCODE_PLUGIN=true`** / Use `INCLUDE_VSCODE_PLUGIN=true` when complete functionality is needed
227+
-**使用 `build:cli` 获得更快的日常构建** / Use `build:cli` for faster daily builds
228+
- 🎨 **需要完整功能时使用 `npm run build`** / Use `npm run build` for full builds
220229
- 🔄 **CI/CD 环境建议使用完整构建** / Recommend complete build for CI/CD environments
221230

222231
## 📚 相关文档 / Related Documentation
@@ -233,17 +242,20 @@ npm run env:test
233242
### 新团队成员快速上手 / Quick Start for New Team Members
234243

235244
1. **克隆项目 / Clone Project**
245+
236246
```bash
237247
git clone <repository-url>
238248
cd DeepCode
239249
```
240250

241251
2. **安装依赖 / Install Dependencies**
252+
242253
```bash
243254
npm install
244255
```
245256

246257
3. **验证环境 / Verify Environment**
258+
247259
```bash
248260
npm run build
249261
npm test
@@ -263,4 +275,4 @@ npm run env:test
263275

264276
---
265277

266-
*最后更新 / Last Updated: 2024-09-25*
278+
_最后更新 / Last Updated: 2024-09-25_

docs/cli/commands.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ Slash commands provide meta-level control over the CLI itself.
4545
- **`/help`** (or **`/?`**)
4646
- **Description:** Display help information about Gemini CLI, including available commands and their usage.
4747

48+
- **`/doctor`**
49+
- **Description:** Run quick diagnostics for the CLI environment (versions, build status, core dependencies).
50+
4851
- **`/mcp`**
4952
- **Description:** List configured Model Context Protocol (MCP) servers, their connection status, server details, and available tools.
5053
- **Sub-commands:**

0 commit comments

Comments
 (0)