Skip to content

Commit 379ffc5

Browse files
committed
docs(readme): 恢复 README-zh_CN.md 文件
1 parent 7f3d1b8 commit 379ffc5

3 files changed

Lines changed: 169 additions & 1 deletion

File tree

File renamed without changes.

README-zh_CN.md

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
<div align="center">
2+
<br/>
3+
<br/>
4+
<p align="center">
5+
<a href='https://deepcode.vegamo.cn/'>
6+
<img src='https://avatars.githubusercontent.com/u/118287711?s=200&v=4' width='100' alt="deepcode-cli"/>
7+
</a>
8+
</p>
9+
<h1>Deep Code CLI</h1>
10+
11+
[English](README-en.md) · 中文
12+
13+
<br/>
14+
</div>
15+
16+
[Deep Code](https://github.com/lessweb/deepcode-cli) 是专为 `deepseek-v4` 模型优化的终端 AI 编码助手,支持深度思考、推理强度控制、Agent Skills 以及 MCP 集成。
17+
18+
## 安装
19+
20+
```bash
21+
npm install -g @vegamo/deepcode-cli
22+
```
23+
24+
在任意项目目录下运行 `deepcode` 即可启动。
25+
26+
![intro2](resources/intro2.png)
27+
28+
## 配置
29+
30+
创建 `~/.deepcode/settings.json` 文件,内容如下:
31+
32+
```json
33+
{
34+
"env": {
35+
"MODEL": "deepseek-v4-pro",
36+
"BASE_URL": "https://api.deepseek.com",
37+
"API_KEY": "sk-..."
38+
},
39+
"thinkingEnabled": true,
40+
"reasoningEffort": "max"
41+
}
42+
```
43+
44+
配置文件与 [Deep Code VSCode 插件](https://github.com/lessweb/deepcode) 共享,无需重复配置。
45+
46+
完整配置说明(多层级优先级、环境变量等)请参阅 [docs/configuration.md](docs/configuration.md)
47+
48+
## 主要功能
49+
50+
### **Skills**
51+
Deep Code CLI 支持 agent skills,允许您扩展助手的能力:
52+
53+
- **User-level Skills**:从 `~/.agents/skills/` 目录中发现并激活 skills。
54+
- **Project-level Skills**:从 `./.agents/skills/` 目录中加载项目专属 skills,并兼容旧的 `./.deepcode/skills/` 目录。
55+
56+
### **为 DeepSeek 优化**
57+
- 专门为 DeepSeek 模型性能调优。
58+
- 通过使用[上下文缓存](https://api-docs.deepseek.com/guides/kv_cache)来降低成本。
59+
- 原生支持[思考模式](https://api-docs.deepseek.com/guides/thinking_mode)和思考强度控制。
60+
61+
## 斜杠命令与按键功能
62+
63+
| 斜杠命令 | 操作 |
64+
|-----------------|---------------------------------------------|
65+
| `/` | 打开 skills / 命令菜单 |
66+
| `/new` | 开始新对话 |
67+
| `/resume` | 选择历史对话继续 |
68+
| `/model` | 切换模型、思考模式和推理强度 |
69+
| `/raw` | 切换显示模式(Normal / Lite / Raw 滚动回溯)|
70+
| `/init` | 初始化 AGENTS.md 文件 |
71+
| `/skills` | 列出可用 skills |
72+
| `/mcp` | 查看 MCP 服务器状态和可用工具 |
73+
| `/exit` | 退出(也可用连续 `Ctrl+D`|
74+
75+
| 按键 | 操作 |
76+
|-----------------|---------------------------------------------|
77+
| `Enter` | 发送消息 |
78+
| `Shift+Enter` | 插入换行(也可用 `Ctrl+J`|
79+
| `Ctrl+V` | 从剪贴板粘贴图片 |
80+
| `Esc` | 中断当前模型回复 |
81+
| 连续 `Ctrl+D` | 退出 |
82+
83+
## 支持的模型
84+
85+
- `deepseek-v4-pro`(推荐使用)
86+
- `deepseek-v4-flash`
87+
- 任何其他 OpenAI 兼容模型
88+
89+
90+
## 常见问题
91+
92+
### Deep Code 是否有 VSCode 插件?
93+
94+
有的。Deep Code 提供功能完整的 VSCode 插件,可在 [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=vegamo.deepcode-vscode) 安装。插件与 CLI 共享 `~/.deepcode/settings.json` 配置文件,可以在终端和编辑器之间无缝切换。
95+
96+
### Deep Code 是否支持理解图片?
97+
98+
Deep Code 支持多模态,可使用ctrl+v从剪贴板粘贴图片。但目前 deepseek-v4 不支持多模态。有些模型虽然有多模态能力,但对多轮对话请求的限制太严。目前多模态输入推荐使用火山方舟的 Doubao-Seed-2.0-pro 模型,适配效果最好。
99+
100+
### 怎样在任务完成后自动给 Slack 发消息?
101+
102+
编写一个调用 Slack webhook 的 Shell 通知脚本,然后在 `~/.deepcode/settings.json` 中将 `notify` 字段设为该脚本的完整路径即可。详细步骤可参考:https://binfer.net/share/jby5xnc-so6g
103+
104+
### 怎样启用联网搜索功能?
105+
106+
Deep Code自带免费的、且大部分情况够用的Web Search工具。如果你希望使用自定义脚本进行联网搜索,可以在 `~/.deepcode/settings.json` 中将 `webSearchTool` 设为脚本的完整路径即可。详细步骤可参考:https://github.com/qorzj/web_search_cli
107+
108+
### 如何配置 MCP?
109+
110+
Deep Code 支持 MCP(Model Context Protocol),可以连接 GitHub、浏览器、数据库等外部服务。在 `settings.json` 中配置 `mcpServers` 字段即可启用,启动后使用 `/mcp` 命令查看已配置的 MCP 服务器状态和可用工具。
111+
112+
详细配置指南:[docs/mcp.md](docs/mcp.md)
113+
114+
115+
### 是否支持 Coding Plan?
116+
117+
支持。只要把 `~/.deepcode/settings.json``env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。以火山方舟的 Coding Plan 为例:
118+
119+
```json
120+
{
121+
"env": {
122+
"MODEL": "ark-code-latest",
123+
"BASE_URL": "https://ark.cn-beijing.volces.com/api/coding/v3",
124+
"API_KEY": "**************"
125+
},
126+
"thinkingEnabled": true
127+
}
128+
```
129+
## 贡献
130+
131+
欢迎贡献代码!以下是参与方式:
132+
133+
```bash
134+
# 克隆仓库
135+
git clone https://github.com/lessweb/deepcode-cli.git
136+
cd deepcode-cli
137+
138+
# 安装依赖
139+
npm install
140+
141+
# 本地开发(类型检查 + lint + 格式检查 + 构建)
142+
npm run build
143+
144+
# 运行测试
145+
npm test
146+
147+
# 链接到全局(即本地全局安装)
148+
npm link
149+
```
150+
151+
- 提交 PR 前请确保 `npm run check` 通过(类型检查 + lint + 格式检查)
152+
- 建议在执行构建前,先执行 `npm run format` 自动格式化代码,避免构建报错
153+
154+
## 获取帮助
155+
156+
- 在 GitHub Issues 上报告错误或请求功能 (https://github.com/lessweb/deepcode-cli/issues)
157+
158+
## 协议
159+
160+
- MIT
161+
162+
## 支持我们
163+
164+
如果你觉得这个工具对你有帮助,请考虑通过以下方式支持我们:
165+
166+
- 在 GitHub 上给我们一个 Star (https://github.com/lessweb/deepcode-cli)
167+
- 向我们提交反馈和建议
168+
- 分享给你的朋友和同事

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</p>
99
<h1>Deep Code CLI</h1>
1010

11-
[English](./README_en.md) · 中文
11+
[English](README-en.md) · 中文
1212

1313
<br/>
1414
</div>

0 commit comments

Comments
 (0)