Skip to content

Commit ca62458

Browse files
qorzjqorzj
authored
Merge pull request #109 from hqwlkj/main
docs: 更新扩展命令菜单说明和帮助文档
2 parents 5b51f40 + 56e7505 commit ca62458

4 files changed

Lines changed: 143 additions & 49 deletions

File tree

‎README-en.md‎

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
</p>
99
<h1>Deep Code CLI</h1>
1010

11+
[![][npm-release-shield]][npm-release-link] [![][npm-downloads-shield]][npm-downloads-link] [![][github-contributors-shield]][github-contributors-link] [![][github-forks-shield]][github-forks-link] [![][github-stars-shield]][github-stars-link]
12+
[![][github-issues-shield]][github-issues-link] [![][github-issues-pr-shield]][github-issues-pr-link] [![][github-license-shield]][github-license-link]
13+
1114
English · [中文](./README.md)
1215

1316
<br/>
@@ -61,17 +64,19 @@ Deep Code CLI supports agent skills that allow you to extend the assistant's cap
6164

6265
## Slash Commands & Keyboard Shortcuts
6366

64-
| Slash Command | Action |
65-
|------------------|----------------------------------------------------------|
66-
| `/` | Open the skills / commands menu |
67-
| `/new` | Start a fresh conversation |
68-
| `/resume` | Choose a previous conversation to continue |
69-
| `/model` | Switch model, thinking mode, and reasoning effort |
70-
| `/raw` | Toggle display mode (Normal / Lite / Raw scrollback) |
71-
| `/init` | Initialize an AGENTS.md file (LLM project instructions) |
72-
| `/skills` | List available skills |
73-
| `/mcp` | View MCP server status and available tools |
74-
| `/exit` | Quit (also `Ctrl+D` twice) |
67+
| Slash Command | Action |
68+
|------------------|---------------------------------------------------------|
69+
| `/` | Open the skills / commands menu |
70+
| `/new` | Start a fresh conversation |
71+
| `/resume` | Choose a previous conversation to continue |
72+
| `/continue` | Continue the active conversation or pick one to resume |
73+
| `/model` | Switch model, thinking mode, and reasoning effort |
74+
| `/raw` | Toggle display mode (Normal / Lite / Raw scrollback) |
75+
| `/init` | Initialize an AGENTS.md file (LLM project instructions) |
76+
| `/skills` | List available skills |
77+
| `/mcp` | View MCP server status and available tools |
78+
| `/undo` | Restore code and/or conversation to a previous point |
79+
| `/exit` | Quit (also `Ctrl+D` twice) |
7580

7681
| Key | Action |
7782
|------------------|----------------------------------------------------------|
@@ -126,6 +131,12 @@ Deep Code supports MCP (Model Context Protocol) to connect external services suc
126131

127132
For detailed setup instructions, see: [docs/mcp.md](docs/mcp.md)
128133

134+
### How to configure Deep Code to send notifications after a task completes?
135+
136+
When the AI assistant completes a task, Deep Code can automatically execute a notification script to send the task results to the specified channel (e.g., Slack, system notifications, etc.).
137+
138+
For detailed configuration instructions, see: [docs/notify_en.md](docs/notify_en.md)
139+
129140
## Contributing
130141

131142
Contributions are welcome! Here's how to get started:
@@ -166,3 +177,23 @@ If you find this tool helpful, please consider supporting us by:
166177
- Giving us a Star on GitHub (https://github.com/lessweb/deepcode-cli)
167178
- Submitting feedback and suggestions
168179
- Sharing with your friends and colleagues
180+
181+
182+
<!-- LINK GROUP -->
183+
184+
[npm-release-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
185+
[npm-release-shield]: https://img.shields.io/npm/v/@vegamo/deepcode-cli?color=4d6BFE&labelColor=black&logo=npm&logoColor=white&style=flat-square
186+
[npm-downloads-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
187+
[npm-downloads-shield]: https://img.shields.io/npm/dt/@vegamo/deepcode-cli?labelColor=black&style=flat-square&color=4d6BFE
188+
[github-contributors-link]: https://github.com/lessweb/deepcode-cli/graphs/contributors
189+
[github-contributors-shield]: https://img.shields.io/github/contributors/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
190+
[github-forks-link]: https://github.com/lessweb/deepcode-cli/network/members
191+
[github-forks-shield]: https://img.shields.io/github/forks/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
192+
[github-stars-link]: https://github.com/lessweb/deepcode-cli/network/stargazers
193+
[github-stars-shield]: https://img.shields.io/github/stars/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
194+
[github-issues-link]: https://github.com/lessweb/deepcode-cli/issues
195+
[github-issues-shield]: https://img.shields.io/github/issues/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
196+
[github-issues-pr-link]: https://github.com/lessweb/deepcode-cli/pulls
197+
[github-issues-pr-shield]: https://img.shields.io/github/issues-pr/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
198+
[github-license-link]: https://github.com/lessweb/deepcode-cli/blob/master/LICENSE
199+
[github-license-shield]: https://img.shields.io/github/license/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square

‎README-zh_CN.md‎

Lines changed: 48 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
</p>
99
<h1>Deep Code CLI</h1>
1010

11+
[![][npm-release-shield]][npm-release-link] [![][npm-downloads-shield]][npm-downloads-link] [![][github-contributors-shield]][github-contributors-link] [![][github-forks-shield]][github-forks-link] [![][github-stars-shield]][github-stars-link]
12+
[![][github-issues-shield]][github-issues-link] [![][github-issues-pr-shield]][github-issues-pr-link] [![][github-license-shield]][github-license-link]
13+
1114
[English](README-en.md) · 中文
1215

1316
<br/>
@@ -60,25 +63,27 @@ Deep Code CLI 支持 agent skills，允许您扩展助手的能力：
6063

6164
## 斜杠命令与按键功能
6265

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` | 退出 |
66+
| 斜杠命令 | 操作 |
67+
|-------------|----------------------------------|
68+
| `/` | 打开 skills / 命令菜单 |
69+
| `/new` | 开始新对话 |
70+
| `/resume` | 选择历史对话继续 |
71+
| `/continue` | 继续当前对话，或选择历史对话恢复 |
72+
| `/model` | 切换模型、思考模式和推理强度 |
73+
| `/raw` | 切换显示模式（Normal / Lite / Raw 滚动回溯） |
74+
| `/init` | 初始化 AGENTS.md 文件 |
75+
| `/skills` | 列出可用 skills |
76+
| `/mcp` | 查看 MCP 服务器状态和可用工具 |
77+
| `/undo` | 将代码和/或对话恢复到之前的状态 |
78+
| `/exit` | 退出（也可用连续 `Ctrl+D`） |
79+
80+
| 按键 | 操作 |
81+
|---------------|--------------------|
82+
| `Enter` | 发送消息 |
83+
| `Shift+Enter` | 插入换行（也可用 `Ctrl+J`） |
84+
| `Ctrl+V` | 从剪贴板粘贴图片 |
85+
| `Esc` | 中断当前模型回复 |
86+
| 连续 `Ctrl+D` | 退出 |
8287

8388
## 支持的模型
8489

@@ -111,6 +116,11 @@ Deep Code 支持 MCP（Model Context Protocol），可以连接 GitHub、浏览
111116

112117
详细配置指南：[docs/mcp.md](docs/mcp.md)
113118

119+
### 如何配置 Deep Code 任务完成后发送通知？
120+
121+
当 AI 助手完成一轮任务后，Deep Code 可以自动执行一个通知脚本，将任务结果发送到你指定的渠道（如 Slack、系统通知等）。
122+
123+
详细配置指南：[docs/notify.md](docs/notify.md)
114124

115125
### 是否支持 Coding Plan？
116126

@@ -166,3 +176,22 @@ npm link
166176
- 在 GitHub 上给我们一个 Star (https://github.com/lessweb/deepcode-cli)
167177
- 向我们提交反馈和建议
168178
- 分享给你的朋友和同事
179+
180+
<!-- LINK GROUP -->
181+
182+
[npm-release-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
183+
[npm-release-shield]: https://img.shields.io/npm/v/@vegamo/deepcode-cli?color=4d6BFE&labelColor=black&logo=npm&logoColor=white&style=flat-square
184+
[npm-downloads-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
185+
[npm-downloads-shield]: https://img.shields.io/npm/dt/@vegamo/deepcode-cli?labelColor=black&style=flat-square&color=4d6BFE
186+
[github-contributors-link]: https://github.com/lessweb/deepcode-cli/graphs/contributors
187+
[github-contributors-shield]: https://img.shields.io/github/contributors/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
188+
[github-forks-link]: https://github.com/lessweb/deepcode-cli/network/members
189+
[github-forks-shield]: https://img.shields.io/github/forks/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
190+
[github-stars-link]: https://github.com/lessweb/deepcode-cli/network/stargazers
191+
[github-stars-shield]: https://img.shields.io/github/stars/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
192+
[github-issues-link]: https://github.com/lessweb/deepcode-cli/issues
193+
[github-issues-shield]: https://img.shields.io/github/issues/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
194+
[github-issues-pr-link]: https://github.com/lessweb/deepcode-cli/pulls
195+
[github-issues-pr-shield]: https://img.shields.io/github/issues-pr/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
196+
[github-license-link]: https://github.com/lessweb/deepcode-cli/blob/master/LICENSE
197+
[github-license-shield]: https://img.shields.io/github/license/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square

‎README.md‎

Lines changed: 48 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
</p>
99
<h1>Deep Code CLI</h1>
1010

11+
[![][npm-release-shield]][npm-release-link] [![][npm-downloads-shield]][npm-downloads-link] [![][github-contributors-shield]][github-contributors-link] [![][github-forks-shield]][github-forks-link] [![][github-stars-shield]][github-stars-link]
12+
[![][github-issues-shield]][github-issues-link] [![][github-issues-pr-shield]][github-issues-pr-link] [![][github-license-shield]][github-license-link]
13+
1114
[English](README-en.md) · 中文
1215

1316
<br/>
@@ -60,25 +63,27 @@ Deep Code CLI 支持 agent skills，允许您扩展助手的能力：
6063

6164
## 斜杠命令与按键功能
6265

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` | 退出 |
66+
| 斜杠命令 | 操作 |
67+
|-------------|----------------------------------|
68+
| `/` | 打开 skills / 命令菜单 |
69+
| `/new` | 开始新对话 |
70+
| `/resume` | 选择历史对话继续 |
71+
| `/continue` | 继续当前对话，或选择历史对话恢复 |
72+
| `/model` | 切换模型、思考模式和推理强度 |
73+
| `/raw` | 切换显示模式（Normal / Lite / Raw 滚动回溯） |
74+
| `/init` | 初始化 AGENTS.md 文件 |
75+
| `/skills` | 列出可用 skills |
76+
| `/mcp` | 查看 MCP 服务器状态和可用工具 |
77+
| `/undo` | 将代码和/或对话恢复到之前的状态 |
78+
| `/exit` | 退出（也可用连续 `Ctrl+D`） |
79+
80+
| 按键 | 操作 |
81+
|---------------|--------------------|
82+
| `Enter` | 发送消息 |
83+
| `Shift+Enter` | 插入换行（也可用 `Ctrl+J`） |
84+
| `Ctrl+V` | 从剪贴板粘贴图片 |
85+
| `Esc` | 中断当前模型回复 |
86+
| 连续 `Ctrl+D` | 退出 |
8287

8388
## 支持的模型
8489

@@ -111,6 +116,11 @@ Deep Code 支持 MCP（Model Context Protocol），可以连接 GitHub、浏览
111116

112117
详细配置指南：[docs/mcp.md](docs/mcp.md)
113118

119+
### 如何配置 Deep Code 任务完成后发送通知？
120+
121+
当 AI 助手完成一轮任务后，Deep Code 可以自动执行一个通知脚本，将任务结果发送到你指定的渠道（如 Slack、系统通知等）。
122+
123+
详细配置指南：[docs/notify.md](docs/notify.md)
114124

115125
### 是否支持 Coding Plan？
116126

@@ -166,3 +176,22 @@ npm link
166176
- 在 GitHub 上给我们一个 Star (https://github.com/lessweb/deepcode-cli)
167177
- 向我们提交反馈和建议
168178
- 分享给你的朋友和同事
179+
180+
<!-- LINK GROUP -->
181+
182+
[npm-release-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
183+
[npm-release-shield]: https://img.shields.io/npm/v/@vegamo/deepcode-cli?color=4d6BFE&labelColor=black&logo=npm&logoColor=white&style=flat-square
184+
[npm-downloads-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
185+
[npm-downloads-shield]: https://img.shields.io/npm/dt/@vegamo/deepcode-cli?labelColor=black&style=flat-square&color=4d6BFE
186+
[github-contributors-link]: https://github.com/lessweb/deepcode-cli/graphs/contributors
187+
[github-contributors-shield]: https://img.shields.io/github/contributors/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
188+
[github-forks-link]: https://github.com/lessweb/deepcode-cli/network/members
189+
[github-forks-shield]: https://img.shields.io/github/forks/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
190+
[github-stars-link]: https://github.com/lessweb/deepcode-cli/network/stargazers
191+
[github-stars-shield]: https://img.shields.io/github/stars/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
192+
[github-issues-link]: https://github.com/lessweb/deepcode-cli/issues
193+
[github-issues-shield]: https://img.shields.io/github/issues/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
194+
[github-issues-pr-link]: https://github.com/lessweb/deepcode-cli/pulls
195+
[github-issues-pr-shield]: https://img.shields.io/github/issues-pr/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
196+
[github-license-link]: https://github.com/lessweb/deepcode-cli/blob/master/LICENSE
197+
[github-license-shield]: https://img.shields.io/github/license/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square

‎src/cli.tsx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,15 @@ if (args.includes("--help") || args.includes("-h")) {
4141
" ctrl+x Clear pasted images",
4242
" esc Interrupt the current model turn",
4343
" / Open the skills/commands menu",
44+
" /skills List available skills",
45+
" /model Select model, thinking mode and effort control",
4446
" /new Start a fresh conversation",
4547
" /init Initialize an AGENTS.md file with instructions for LLM",
4648
" /resume Pick a previous conversation to continue",
4749
" /continue Continue the active conversation, or resume one if empty",
50+
" /undo Restore code and/or conversation to a previous point",
51+
" /mcp Show MCP server status and available tools",
52+
" /raw Toggle display mode for viewing or collapsing reasoning content",
4853
" /exit Quit",
4954
" ctrl+d twice Quit",
5055
].join("\n") + "\n"

0 commit comments

Comments
 (0)