Skip to content

Commit d5ad0fb

Browse files
qorzjqorzj
committed
feat: update README.md
1 parent a300172 commit d5ad0fb

4 files changed

Lines changed: 163 additions & 63 deletions

File tree

‎README.md‎

Lines changed: 52 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
11
# Deep Code CLI
22

3-
[Deep Code](https://github.com/lessweb/deepcode-cli) 是专为 `deepseek-v4` 模型优化的终端 AI 编码助手，支持深度思考、推理强度控制以及 Agent Skills。
4-
5-
## 🚀 新增功能（本 Fork）
6-
7-
### `/mcp` Skill 与 MCP 实现
8-
9-
本 Fork 新增了 `/mcp` 命令和 MCP（Model Context Protocol）集成，让 Deep Code CLI 能够连接外部工具和服务：
10-
11-
- **`/mcp` Skill**：一键管理 MCP 服务器连接，支持添加、移除、列出已配置的 MCP 服务。
12-
- **MCP 协议实现**：支持与 GitHub、文件系统、数据库等多种外部服务的标准化集成，大幅扩展 AI 助手的操作能力。
13-
14-
通过 MCP，你现在可以让 Deep Code 直接操作 GitHub 仓库、读取文件、查询数据库等，而无需离开终端。
15-
16-
📖 **详细配置指南：** [docs/mcp.md](docs/mcp.md)
3+
[Deep Code](https://github.com/lessweb/deepcode-cli) 是专为 `deepseek-v4` 模型优化的终端 AI 编码助手，支持深度思考、推理强度控制、Agent Skills 以及 MCP 集成。
174

185
## 安装
196

@@ -43,6 +30,8 @@ npm install -g @vegamo/deepcode-cli
4330

4431
配置文件与 [Deep Code VSCode 插件](https://github.com/lessweb/deepcode) 共享，无需重复配置。
4532

33+
完整配置说明（多层级优先级、环境变量等）请参阅 [docs/configuration.md](docs/configuration.md)。
34+
4635
## 主要功能
4736

4837
### **Skills**
@@ -56,20 +45,26 @@ Deep Code CLI 支持 agent skills，允许您扩展助手的能力：
5645
- 通过使用[上下文缓存](https://api-docs.deepseek.com/guides/kv_cache)来降低成本。
5746
- 原生支持[思考模式](https://api-docs.deepseek.com/guides/thinking_mode)和思考强度控制。
5847

59-
## 快捷键
60-
61-
| 键 | 操作 |
62-
|-----------------|-----------------------------------|
63-
| `Enter` | 发送消息 |
64-
| `Shift+Enter` | 插入换行（也可用 `Ctrl+J`） |
65-
| `Ctrl+V` | 从剪贴板粘贴图片 |
66-
| `Esc` | 中断当前模型回复 |
67-
| `/` | 打开 skills / 命令菜单 |
68-
| `/new` | 开始新对话 |
69-
| `/resume` | 选择历史对话继续 |
70-
| `/skills` | 列出可用 skills |
71-
| `/exit` | 退出 |
72-
| 连续 `Ctrl+D` | 退出 |
48+
## 斜杠命令与按键功能
49+
50+
| 斜杠命令 | 操作 |
51+
|-----------------|---------------------------------------------|
52+
| `/` | 打开 skills / 命令菜单 |
53+
| `/new` | 开始新对话 |
54+
| `/resume` | 选择历史对话继续 |
55+
| `/model` | 切换模型、思考模式和推理强度 |
56+
| `/init` | 初始化 AGENTS.md 文件 |
57+
| `/skills` | 列出可用 skills |
58+
| `/mcp` | 查看 MCP 服务器状态和可用工具 |
59+
| `/exit` | 退出（也可用连续 `Ctrl+D`） |
60+
61+
| 按键 | 操作 |
62+
|-----------------|---------------------------------------------|
63+
| `Enter` | 发送消息 |
64+
| `Shift+Enter` | 插入换行（也可用 `Ctrl+J`） |
65+
| `Ctrl+V` | 从剪贴板粘贴图片 |
66+
| `Esc` | 中断当前模型回复 |
67+
| 连续 `Ctrl+D` | 退出 |
7368

7469
## 支持的模型
7570

@@ -96,6 +91,13 @@ Deep Code 支持多模态，可使用ctrl+v从剪贴板粘贴图片。但目前
9691

9792
Deep Code自带免费的、且大部分情况够用的Web Search工具。如果你希望使用自定义脚本进行联网搜索，可以在 `~/.deepcode/settings.json` 中将 `webSearchTool` 设为脚本的完整路径即可。详细步骤可参考：https://github.com/qorzj/web_search_cli
9893

94+
### 如何配置 MCP？
95+
96+
Deep Code 支持 MCP（Model Context Protocol），可以连接 GitHub、浏览器、数据库等外部服务。在 `settings.json` 中配置 `mcpServers` 字段即可启用，启动后使用 `/mcp` 命令查看已配置的 MCP 服务器状态和可用工具。
97+
98+
详细配置指南：[docs/mcp.md](docs/mcp.md)
99+
100+
99101
### 是否支持 Coding Plan？
100102

101103
支持。只要把 `~/.deepcode/settings.json` 的 `env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。以火山方舟的 Coding Plan 为例：
@@ -110,10 +112,30 @@ Deep Code自带免费的、且大部分情况够用的Web Search工具。如果
110112
"thinkingEnabled": true
111113
}
112114
```
115+
## 贡献
113116

114-
### 如何配置 MCP？
117+
欢迎贡献代码！以下是参与方式：
118+
119+
```bash
120+
# 克隆仓库
121+
git clone https://github.com/lessweb/deepcode-cli.git
122+
cd deepcode-cli
123+
124+
# 安装依赖
125+
npm install
126+
127+
# 本地开发（类型检查 + lint + 格式检查 + 构建）
128+
npm run build
129+
130+
# 运行测试
131+
npm test
132+
133+
# 链接到全局（即本地全局安装）
134+
npm link
135+
```
115136

116-
Deep Code CLI 支持 MCP（Model Context Protocol），可以连接 GitHub、浏览器、文件系统等外部服务。配置方法请查看：[docs/mcp.md](docs/mcp.md)
137+
- 提交 PR 前请确保 `npm run check` 通过（类型检查 + lint + 格式检查）
138+
- 建议在执行构建前，先执行 `npm run format` 自动格式化代码，避免构建报错
117139

118140
## 获取帮助
119141

‎README_cn.md‎

Lines changed: 54 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Deep Code CLI
22

3-
[Deep Code](https://github.com/lessweb/deepcode-cli) 是专为 `deepseek-v4` 模型优化的终端 AI 编码助手，支持深度思考、推理强度控制以及 Agent Skills。
3+
[Deep Code](https://github.com/lessweb/deepcode-cli) 是专为 `deepseek-v4` 模型优化的终端 AI 编码助手，支持深度思考、推理强度控制、Agent Skills 以及 MCP 集成。
44

55
## 安装
66

@@ -30,6 +30,8 @@ npm install -g @vegamo/deepcode-cli
3030

3131
配置文件与 [Deep Code VSCode 插件](https://github.com/lessweb/deepcode) 共享，无需重复配置。
3232

33+
完整配置说明（多层级优先级、环境变量等）请参阅 [docs/configuration.md](docs/configuration.md)。
34+
3335
## 主要功能
3436

3537
### **Skills**
@@ -43,20 +45,26 @@ Deep Code CLI 支持 agent skills，允许您扩展助手的能力：
4345
- 通过使用[上下文缓存](https://api-docs.deepseek.com/guides/kv_cache)来降低成本。
4446
- 原生支持[思考模式](https://api-docs.deepseek.com/guides/thinking_mode)和思考强度控制。
4547

46-
## 快捷键
47-
48-
| 键 | 操作 |
49-
|-----------------|-----------------------------------|
50-
| `Enter` | 发送消息 |
51-
| `Shift+Enter` | 插入换行（也可用 `Ctrl+J`） |
52-
| `Ctrl+V` | 从剪贴板粘贴图片 |
53-
| `Esc` | 中断当前模型回复 |
54-
| `/` | 打开 skills / 命令菜单 |
55-
| `/new` | 开始新对话 |
56-
| `/resume` | 选择历史对话继续 |
57-
| `/skills` | 列出可用 skills |
58-
| `/exit` | 退出 |
59-
| 连续 `Ctrl+D` | 退出 |
48+
## 斜杠命令与按键功能
49+
50+
| 斜杠命令 | 操作 |
51+
|-----------------|---------------------------------------------|
52+
| `/` | 打开 skills / 命令菜单 |
53+
| `/new` | 开始新对话 |
54+
| `/resume` | 选择历史对话继续 |
55+
| `/model` | 切换模型、思考模式和推理强度 |
56+
| `/init` | 初始化 AGENTS.md 文件 |
57+
| `/skills` | 列出可用 skills |
58+
| `/mcp` | 查看 MCP 服务器状态和可用工具 |
59+
| `/exit` | 退出（也可用连续 `Ctrl+D`） |
60+
61+
| 按键 | 操作 |
62+
|-----------------|---------------------------------------------|
63+
| `Enter` | 发送消息 |
64+
| `Shift+Enter` | 插入换行（也可用 `Ctrl+J`） |
65+
| `Ctrl+V` | 从剪贴板粘贴图片 |
66+
| `Esc` | 中断当前模型回复 |
67+
| 连续 `Ctrl+D` | 退出 |
6068

6169
## 支持的模型
6270

@@ -83,6 +91,13 @@ Deep Code 支持多模态，可使用ctrl+v从剪贴板粘贴图片。但目前
8391

8492
Deep Code自带免费的、且大部分情况够用的Web Search工具。如果你希望使用自定义脚本进行联网搜索，可以在 `~/.deepcode/settings.json` 中将 `webSearchTool` 设为脚本的完整路径即可。详细步骤可参考：https://github.com/qorzj/web_search_cli
8593

94+
### 如何配置 MCP？
95+
96+
Deep Code 支持 MCP（Model Context Protocol），可以连接 GitHub、浏览器、数据库等外部服务。在 `settings.json` 中配置 `mcpServers` 字段即可启用，启动后使用 `/mcp` 命令查看已配置的 MCP 服务器状态和可用工具。
97+
98+
详细配置指南：[docs/mcp.md](docs/mcp.md)
99+
100+
86101
### 是否支持 Coding Plan？
87102

88103
支持。只要把 `~/.deepcode/settings.json` 的 `env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。以火山方舟的 Coding Plan 为例：
@@ -97,6 +112,30 @@ Deep Code自带免费的、且大部分情况够用的Web Search工具。如果
97112
"thinkingEnabled": true
98113
}
99114
```
115+
## 贡献
116+
117+
欢迎贡献代码！以下是参与方式：
118+
119+
```bash
120+
# 克隆仓库
121+
git clone https://github.com/lessweb/deepcode-cli.git
122+
cd deepcode-cli
123+
124+
# 安装依赖
125+
npm install
126+
127+
# 本地开发（类型检查 + lint + 格式检查 + 构建）
128+
npm run build
129+
130+
# 运行测试
131+
npm test
132+
133+
# 链接到全局（即本地全局安装）
134+
npm link
135+
```
136+
137+
- 提交 PR 前请确保 `npm run check` 通过（类型检查 + lint + 格式检查）
138+
- 建议在执行构建前，先执行 `npm run format` 自动格式化代码，避免构建报错
100139

101140
## 获取帮助
102141

‎README_en.md‎

Lines changed: 56 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Deep Code CLI
22

3-
[Deep Code](https://github.com/lessweb/deepcode-cli) is a terminal AI coding assistant optimized for the `deepseek-v4` model, with support for deep thinking, reasoning effort control, and Agent Skills.
3+
[Deep Code](https://github.com/lessweb/deepcode-cli) is a terminal AI coding assistant optimized for the `deepseek-v4` model, with support for deep thinking, reasoning effort control, Agent Skills, and MCP (Model Context Protocol) integration.
44

55
## Installation
66

@@ -30,6 +30,8 @@ Create `~/.deepcode/settings.json`:
3030

3131
The configuration file is shared with the [Deep Code VSCode extension](https://github.com/lessweb/deepcode) — configure once, use everywhere.
3232

33+
For complete configuration details (multi-level priority, environment variables, etc.), see [docs/configuration.md](docs/configuration.md).
34+
3335
## Key Features
3436

3537
### **Skills**
@@ -41,22 +43,28 @@ Deep Code CLI supports agent skills that allow you to extend the assistant's cap
4143
### **Optimized for DeepSeek**
4244
- Specifically tuned for DeepSeek model performance.
4345
- Reduce costs by using [Context Caching](https://api-docs.deepseek.com/guides/kv_cache).
44-
- Natively supports [Thinking Mode](https://api-docs.deepseek.com/guides/thinking_mode) and Thinking Effort Control.
45-
46-
## Keyboard Shortcuts
47-
48-
| Key | Action |
49-
|-----------------|----------------------------------------------|
50-
| `Enter` | Send the prompt |
51-
| `Shift+Enter` | Insert a newline (also `Ctrl+J`) |
52-
| `Ctrl+V` | Paste an image from the clipboard |
53-
| `Esc` | Interrupt the current model turn |
54-
| `/` | Open the skills / commands menu |
55-
| `/new` | Start a fresh conversation |
56-
| `/resume` | Choose a previous conversation to continue |
57-
| `/skills` | List available skills |
58-
| `/exit` | Quit Deep Code |
59-
| `Ctrl+D` twice | Quit Deep Code |
46+
- Natively supports [Thinking Mode](https://api-docs.deepseek.com/guides/thinking_mode) and Effort Control.
47+
48+
## Slash Commands & Keyboard Shortcuts
49+
50+
| Slash Command | Action |
51+
|------------------|----------------------------------------------------------|
52+
| `/` | Open the skills / commands menu |
53+
| `/new` | Start a fresh conversation |
54+
| `/resume` | Choose a previous conversation to continue |
55+
| `/model` | Switch model, thinking mode, and reasoning effort |
56+
| `/init` | Initialize an AGENTS.md file (LLM project instructions) |
57+
| `/skills` | List available skills |
58+
| `/mcp` | View MCP server status and available tools |
59+
| `/exit` | Quit (also `Ctrl+D` twice) |
60+
61+
| Key | Action |
62+
|------------------|----------------------------------------------------------|
63+
| `Enter` | Send the prompt |
64+
| `Shift+Enter` | Insert a newline (also `Ctrl+J`) |
65+
| `Ctrl+V` | Paste an image from the clipboard |
66+
| `Esc` | Interrupt the current model turn |
67+
| `Ctrl+D` twice | Quit Deep Code |
6068

6169
## Supported Models
6270

@@ -97,6 +105,37 @@ Yes. Just set `env.BASE_URL` in `~/.deepcode/settings.json` to an OpenAI-compati
97105
}
98106
```
99107

108+
### How do I configure MCP?
109+
110+
Deep Code supports MCP (Model Context Protocol) to connect external services such as GitHub, browsers, databases, and more. Configure the `mcpServers` field in `settings.json` to enable it, then use the `/mcp` command to view MCP server status and available tools.
111+
112+
For detailed setup instructions, see: [docs/mcp.md](docs/mcp.md)
113+
114+
## Contributing
115+
116+
Contributions are welcome! Here's how to get started:
117+
118+
```bash
119+
# Clone the repository
120+
git clone https://github.com/lessweb/deepcode-cli.git
121+
cd deepcode-cli
122+
123+
# Install dependencies
124+
npm install
125+
126+
# Local development (typecheck + lint + format check + bundle)
127+
npm run build
128+
129+
# Run tests
130+
npm test
131+
132+
# Link globally (local global install)
133+
npm link
134+
```
135+
136+
- Make sure `npm run check` passes before submitting a PR (typecheck + lint + format check)
137+
- We recommend running `npm run format` before building to avoid errors
138+
100139
## Getting Help
101140

102141
- Report bugs or request features on GitHub Issues (https://github.com/lessweb/deepcode-cli/issues)

‎src/ui/slashCommands.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export const BUILTIN_SLASH_COMMANDS: SlashCommandItem[] = [
2121
kind: "model",
2222
name: "model",
2323
label: "/model",
24-
description: "Select model, thinking mode and thinking effort",
24+
description: "Select model, thinking mode and effort control",
2525
},
2626
{
2727
kind: "new",

0 commit comments

Comments
 (0)