Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 42 additions & 11 deletions README-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
</p>
<h1>Deep Code CLI</h1>

[![][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]
[![][github-issues-shield]][github-issues-link] [![][github-issues-pr-shield]][github-issues-pr-link] [![][github-license-shield]][github-license-link]

English · [中文](./README.md)

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

## Slash Commands & Keyboard Shortcuts

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

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

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

### How to configure Deep Code to send notifications after a task completes?

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.).

For detailed configuration instructions, see: [docs/notify_en.md](docs/notify_en.md)

## Contributing

Contributions are welcome! Here's how to get started:
Expand Down Expand Up @@ -166,3 +177,23 @@ If you find this tool helpful, please consider supporting us by:
- Giving us a Star on GitHub (https://github.com/lessweb/deepcode-cli)
- Submitting feedback and suggestions
- Sharing with your friends and colleagues


<!-- LINK GROUP -->

[npm-release-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
[npm-release-shield]: https://img.shields.io/npm/v/@vegamo/deepcode-cli?color=4d6BFE&labelColor=black&logo=npm&logoColor=white&style=flat-square
[npm-downloads-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
[npm-downloads-shield]: https://img.shields.io/npm/dt/@vegamo/deepcode-cli?labelColor=black&style=flat-square&color=4d6BFE
[github-contributors-link]: https://github.com/lessweb/deepcode-cli/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/lessweb/deepcode-cli/network/members
[github-forks-shield]: https://img.shields.io/github/forks/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-stars-link]: https://github.com/lessweb/deepcode-cli/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/lessweb/deepcode-cli/issues
[github-issues-shield]: https://img.shields.io/github/issues/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-issues-pr-link]: https://github.com/lessweb/deepcode-cli/pulls
[github-issues-pr-shield]: https://img.shields.io/github/issues-pr/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-license-link]: https://github.com/lessweb/deepcode-cli/blob/master/LICENSE
[github-license-shield]: https://img.shields.io/github/license/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
67 changes: 48 additions & 19 deletions README-zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
</p>
<h1>Deep Code CLI</h1>

[![][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]
[![][github-issues-shield]][github-issues-link] [![][github-issues-pr-shield]][github-issues-pr-link] [![][github-license-shield]][github-license-link]

[English](README-en.md) · 中文

<br/>
Expand Down Expand Up @@ -60,25 +63,27 @@ Deep Code CLI 支持 agent skills,允许您扩展助手的能力:

## 斜杠命令与按键功能

| 斜杠命令 | 操作 |
|-----------------|---------------------------------------------|
| `/` | 打开 skills / 命令菜单 |
| `/new` | 开始新对话 |
| `/resume` | 选择历史对话继续 |
| `/model` | 切换模型、思考模式和推理强度 |
| `/raw` | 切换显示模式(Normal / Lite / Raw 滚动回溯)|
| `/init` | 初始化 AGENTS.md 文件 |
| `/skills` | 列出可用 skills |
| `/mcp` | 查看 MCP 服务器状态和可用工具 |
| `/exit` | 退出(也可用连续 `Ctrl+D`) |

| 按键 | 操作 |
|-----------------|---------------------------------------------|
| `Enter` | 发送消息 |
| `Shift+Enter` | 插入换行(也可用 `Ctrl+J`) |
| `Ctrl+V` | 从剪贴板粘贴图片 |
| `Esc` | 中断当前模型回复 |
| 连续 `Ctrl+D` | 退出 |
| 斜杠命令 | 操作 |
|-------------|----------------------------------|
| `/` | 打开 skills / 命令菜单 |
| `/new` | 开始新对话 |
| `/resume` | 选择历史对话继续 |
| `/continue` | 继续当前对话,或选择历史对话恢复 |
| `/model` | 切换模型、思考模式和推理强度 |
| `/raw` | 切换显示模式(Normal / Lite / Raw 滚动回溯) |
| `/init` | 初始化 AGENTS.md 文件 |
| `/skills` | 列出可用 skills |
| `/mcp` | 查看 MCP 服务器状态和可用工具 |
| `/undo` | 将代码和/或对话恢复到之前的状态 |
| `/exit` | 退出(也可用连续 `Ctrl+D`) |

| 按键 | 操作 |
|---------------|--------------------|
| `Enter` | 发送消息 |
| `Shift+Enter` | 插入换行(也可用 `Ctrl+J`) |
| `Ctrl+V` | 从剪贴板粘贴图片 |
| `Esc` | 中断当前模型回复 |
| 连续 `Ctrl+D` | 退出 |

## 支持的模型

Expand Down Expand Up @@ -111,6 +116,11 @@ Deep Code 支持 MCP(Model Context Protocol),可以连接 GitHub、浏览

详细配置指南:[docs/mcp.md](docs/mcp.md)

### 如何配置 Deep Code 任务完成后发送通知?

当 AI 助手完成一轮任务后,Deep Code 可以自动执行一个通知脚本,将任务结果发送到你指定的渠道(如 Slack、系统通知等)。

详细配置指南:[docs/notify.md](docs/notify.md)

### 是否支持 Coding Plan?

Expand Down Expand Up @@ -166,3 +176,22 @@ npm link
- 在 GitHub 上给我们一个 Star (https://github.com/lessweb/deepcode-cli)
- 向我们提交反馈和建议
- 分享给你的朋友和同事

<!-- LINK GROUP -->

[npm-release-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
[npm-release-shield]: https://img.shields.io/npm/v/@vegamo/deepcode-cli?color=4d6BFE&labelColor=black&logo=npm&logoColor=white&style=flat-square
[npm-downloads-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
[npm-downloads-shield]: https://img.shields.io/npm/dt/@vegamo/deepcode-cli?labelColor=black&style=flat-square&color=4d6BFE
[github-contributors-link]: https://github.com/lessweb/deepcode-cli/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/lessweb/deepcode-cli/network/members
[github-forks-shield]: https://img.shields.io/github/forks/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-stars-link]: https://github.com/lessweb/deepcode-cli/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/lessweb/deepcode-cli/issues
[github-issues-shield]: https://img.shields.io/github/issues/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-issues-pr-link]: https://github.com/lessweb/deepcode-cli/pulls
[github-issues-pr-shield]: https://img.shields.io/github/issues-pr/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-license-link]: https://github.com/lessweb/deepcode-cli/blob/master/LICENSE
[github-license-shield]: https://img.shields.io/github/license/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
67 changes: 48 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
</p>
<h1>Deep Code CLI</h1>

[![][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]
[![][github-issues-shield]][github-issues-link] [![][github-issues-pr-shield]][github-issues-pr-link] [![][github-license-shield]][github-license-link]

[English](README-en.md) · 中文

<br/>
Expand Down Expand Up @@ -60,25 +63,27 @@ Deep Code CLI 支持 agent skills,允许您扩展助手的能力:

## 斜杠命令与按键功能

| 斜杠命令 | 操作 |
|-----------------|---------------------------------------------|
| `/` | 打开 skills / 命令菜单 |
| `/new` | 开始新对话 |
| `/resume` | 选择历史对话继续 |
| `/model` | 切换模型、思考模式和推理强度 |
| `/raw` | 切换显示模式(Normal / Lite / Raw 滚动回溯)|
| `/init` | 初始化 AGENTS.md 文件 |
| `/skills` | 列出可用 skills |
| `/mcp` | 查看 MCP 服务器状态和可用工具 |
| `/exit` | 退出(也可用连续 `Ctrl+D`) |

| 按键 | 操作 |
|-----------------|---------------------------------------------|
| `Enter` | 发送消息 |
| `Shift+Enter` | 插入换行(也可用 `Ctrl+J`) |
| `Ctrl+V` | 从剪贴板粘贴图片 |
| `Esc` | 中断当前模型回复 |
| 连续 `Ctrl+D` | 退出 |
| 斜杠命令 | 操作 |
|-------------|----------------------------------|
| `/` | 打开 skills / 命令菜单 |
| `/new` | 开始新对话 |
| `/resume` | 选择历史对话继续 |
| `/continue` | 继续当前对话,或选择历史对话恢复 |
| `/model` | 切换模型、思考模式和推理强度 |
| `/raw` | 切换显示模式(Normal / Lite / Raw 滚动回溯) |
| `/init` | 初始化 AGENTS.md 文件 |
| `/skills` | 列出可用 skills |
| `/mcp` | 查看 MCP 服务器状态和可用工具 |
| `/undo` | 将代码和/或对话恢复到之前的状态 |
| `/exit` | 退出(也可用连续 `Ctrl+D`) |

| 按键 | 操作 |
|---------------|--------------------|
| `Enter` | 发送消息 |
| `Shift+Enter` | 插入换行(也可用 `Ctrl+J`) |
| `Ctrl+V` | 从剪贴板粘贴图片 |
| `Esc` | 中断当前模型回复 |
| 连续 `Ctrl+D` | 退出 |

## 支持的模型

Expand Down Expand Up @@ -111,6 +116,11 @@ Deep Code 支持 MCP(Model Context Protocol),可以连接 GitHub、浏览

详细配置指南:[docs/mcp.md](docs/mcp.md)

### 如何配置 Deep Code 任务完成后发送通知?

当 AI 助手完成一轮任务后,Deep Code 可以自动执行一个通知脚本,将任务结果发送到你指定的渠道(如 Slack、系统通知等)。

详细配置指南:[docs/notify.md](docs/notify.md)

### 是否支持 Coding Plan?

Expand Down Expand Up @@ -166,3 +176,22 @@ npm link
- 在 GitHub 上给我们一个 Star (https://github.com/lessweb/deepcode-cli)
- 向我们提交反馈和建议
- 分享给你的朋友和同事

<!-- LINK GROUP -->

[npm-release-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
[npm-release-shield]: https://img.shields.io/npm/v/@vegamo/deepcode-cli?color=4d6BFE&labelColor=black&logo=npm&logoColor=white&style=flat-square
[npm-downloads-link]: https://www.npmjs.com/package/@vegamo/deepcode-cli
[npm-downloads-shield]: https://img.shields.io/npm/dt/@vegamo/deepcode-cli?labelColor=black&style=flat-square&color=4d6BFE
[github-contributors-link]: https://github.com/lessweb/deepcode-cli/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/lessweb/deepcode-cli/network/members
[github-forks-shield]: https://img.shields.io/github/forks/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-stars-link]: https://github.com/lessweb/deepcode-cli/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/lessweb/deepcode-cli/issues
[github-issues-shield]: https://img.shields.io/github/issues/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-issues-pr-link]: https://github.com/lessweb/deepcode-cli/pulls
[github-issues-pr-shield]: https://img.shields.io/github/issues-pr/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
[github-license-link]: https://github.com/lessweb/deepcode-cli/blob/master/LICENSE
[github-license-shield]: https://img.shields.io/github/license/lessweb/deepcode-cli?color=4d6BFE&labelColor=black&style=flat-square
5 changes: 5 additions & 0 deletions src/cli.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,15 @@ if (args.includes("--help") || args.includes("-h")) {
" ctrl+x Clear pasted images",
" esc Interrupt the current model turn",
" / Open the skills/commands menu",
" /skills List available skills",
" /model Select model, thinking mode and effort control",
" /new Start a fresh conversation",
" /init Initialize an AGENTS.md file with instructions for LLM",
" /resume Pick a previous conversation to continue",
" /continue Continue the active conversation, or resume one if empty",
" /undo Restore code and/or conversation to a previous point",
" /mcp Show MCP server status and available tools",
" /raw Toggle display mode for viewing or collapsing reasoning content",
" /exit Quit",
" ctrl+d twice Quit",
].join("\n") + "\n"
Expand Down
Loading