Deep Copilot

🇨🇳 嵌入 VS Code 的 AI 编程助手 · 由 DeepSeek V4 驱动
🇬🇧 An AI coding agent embedded in VS Code, powered by DeepSeek V4

🇨🇳 Deep Copilot 是一个把 Copilot 风格的 AI Agent 直接搬进 VS Code 的扩展。它通过 DeepSeek API（OpenAI 兼容协议）与模型对话，调用工具读写文件、搜索代码、执行 Shell 命令，并把整个过程实时呈现在侧边栏中。无需后端、无需 Docker、无需 Rust，纯 Node.js / 浏览器 API 实现。

🇬🇧 Deep Copilot brings a Copilot-style AI agent directly into VS Code. It talks to DeepSeek (OpenAI-compatible) and lets the model call tools to read/write files, search code, and run shell commands — streamed live into the sidebar. No backend, no Docker, no Rust — pure Node.js + browser APIs.

📑 Table of Contents · 目录

• Highlights · 亮点
• Quick Start · 快速开始
• Build from Source · 源码构建
• Configuration · 配置
• Keybindings · 快捷键
• Tools · 工具列表
• Architecture · 架构
• Project Structure · 项目结构
• Development · 开发
• Troubleshooting · 故障排查
• Changelog · 更新日志
• License

✨ Highlights · 亮点

🚀 Quick Start · 快速开始

Option 1 — VS Code Marketplace · 从扩展商城安装（推荐）

1. Open VS Code → Extensions (Ctrl/Cmd+Shift+X) → Search Deep Copilot → Install. 打开 VS Code → 扩展面板（Ctrl/Cmd+Shift+X）→ 搜索 Deep Copilot → 安装。

Option 2 — Install the prebuilt VSIX · 安装预构建 VSIX

# 从 GitHub Releases 下载最新版 / Download from GitHub Releases:
# https://github.com/ZhouChaunge/DeepCopilot/releases

code --install-extension deep-copilot-0.28.14.vsix

Or in VS Code: Extensions view → ⋯ menu → Install from VSIX... and pick the file. 或在扩展面板右上角 ⋯ → Install from VSIX... 选择文件。

Step 2 — Set the API key · 配置 API Key

1. Click the 🐋 Deep Copilot icon in the activity bar to open the chat panel.点击活动栏中的 🐋 Deep Copilot 图标，打开聊天面板。
2. Click the 🔑 button at the bottom right of the panel, paste your DeepSeek API key.点击面板右下角 🔑 按钮，粘贴你的 DeepSeek API Key。
3. Start chatting! 开始对话！

🇨🇳 国内用户提示：如果连接 api.deepseek.com 不稳定，点 🔑 按钮后再点 Base URL 切到 https://api.deepseeki.com。

🇬🇧 China users: if api.deepseek.com is slow, click 🔑 → set Base URL to https://api.deepseeki.com.

🛠 Build from Source · 源码构建

Prerequisites · 前置依赖

Steps · 构建步骤

# 1. Clone the repo · 克隆仓库
git clone https://github.com/ZhouChaunge/DeepCopilot.git
cd DeepCopilot

# 2. Install dependencies · 安装依赖
#    (only devDependencies: esbuild + vsce + @types — runtime is pure VS Code API)
#    （只有开发依赖；运行时仅用 VS Code API，无运行时 npm 依赖）
npm install

# 3. Build the bundle · 编译为单文件
npm run build
# -> outputs out/extension.js (~105 KB minified)
# -> 产出 out/extension.js（约 105 KB，已压缩）

# 4. Package as VSIX · 打包 VSIX
npm run package
# -> outputs deep-copilot-0.28.14.vsix
# -> 产出 deep-copilot-0.28.14.vsix

# 5. Install locally · 本地安装
code --install-extension deep-copilot-0.28.14.vsix --force

Watch mode · 监听模式（开发期）

npm run watch
# Rebuilds out/extension.js on every src/ change.
# 修改 src/ 任何文件即增量重建 out/extension.js。
# Then: F5 in VS Code (with the repo opened) launches the Extension Development Host.
# 然后在 VS Code 里按 F5 启动“扩展开发宿主”加载本地构建。

What gets built · 构建产物说明

🇬🇧 Everything required to compile is in the repo. out/ and *.vsix are reproducible artifacts. 🇨🇳 编译所需文件全部在仓库里。out/ 和 *.vsix 是可重现的产物，已 .gitignore。

⚙️ Configuration · 配置

All settings live under the deepseekAgent.* namespace in settings.json. 所有设置都在 settings.json 的 deepseekAgent.* 命名空间下。

Approval Modes · 审批模式

⌨️ Keybindings · 快捷键

🧰 Tools · 工具列表

Deep Copilot exposes a small, deliberately-minimal tool set to the model: Deep Copilot 给模型暴露的工具集刻意保持精简：

🇬🇧 Tool definitions live in src/tools/schema.js; execution in src/tools/exec.js.

🇨🇳 工具定义见 src/tools/schema.js，执行实现见 src/tools/exec.js。

🏗️ Architecture · 架构

┌──────────────────────────────────────────────────────────┐
│                  VS Code Extension Host                  │
│                                                          │
│  ┌────────────────────────────────────────────────────┐  │
│  │ src/extension.js  (activate / commands)            │  │
│  └────────────────────────────────────────────────────┘  │
│                          │                               │
│                          ▼                               │
│  ┌────────────────────────────────────────────────────┐  │
│  │ src/chat/provider.js  (ChatViewProvider)           │  │
│  │   • Webview ↔ Extension message bus                │  │
│  │   • Per-session run map  (parallel sessions)       │  │
│  │   • Persisted history    (globalState)             │  │
│  │   • Plan / Todos state                             │  │
│  └────────────────────────────────────────────────────┘  │
│            │                            │                │
│            ▼                            ▼                │
│  ┌──────────────────┐        ┌────────────────────────┐  │
│  │ src/api/         │        │ src/tools/             │  │
│  │  deepseek.js     │        │  schema.js  (defs)     │  │
│  │  • SSE streaming │        │  exec.js    (runtime)  │  │
│  │  • Tool calls    │        │  • read/write/list     │  │
│  │  • Reasoning     │        │  • grep / shell        │  │
│  └──────────────────┘        │  • approval gating     │  │
│                              └────────────────────────┘  │
│                                                          │
│  ┌────────────────────────────────────────────────────┐  │
│  │ src/webview/html.js   (HTML shell injected)        │  │
│  │ media/chat.js + chat.css   (UI runtime + styles)   │  │
│  └────────────────────────────────────────────────────┘  │
└──────────────────────────────────────────────────────────┘
                          │  HTTPS (SSE)
                          ▼
              ┌────────────────────────┐
              │  DeepSeek Platform     │
              │  api.deepseek.com      │
              │  (OpenAI-compatible)   │
              └────────────────────────┘

Key design points · 关键设计

• 🇬🇧 No backend. Everything runs inside the VS Code extension host. The single bundle out/extension.js is approx 94 KB. 🇨🇳 无后端。 全部跑在 VS Code 扩展主机里，单文件构建产物 out/extension.js 仅约94KB。
• 🇬🇧 Per-session run map. provider._runs: Map<sessionId, Run> lets you switch sessions while a task is running; the run keeps producing events that get buffered and replayed when you return. 🇨🇳 按会话隔离的 run 表。 provider._runs 让你在任务跑着时切到别的会话，事件继续缓冲，切回来自动回放。
• 🇬🇧 Streaming via SSE. src/api/deepseek.js parses data: frames and forwards delta, reasoning, tool_calls, usage to the provider. 🇨🇳 SSE 流式。 src/api/deepseek.js 解析 data: 帧，把 delta / reasoning / tool_calls / usage 转发给 provider。
• 🇬🇧 Auto-compaction. Once estimated tokens exceed compactBudgetTokens, older tool results are dropped before the next round. 🇨🇳 自动压缩。 估算 token 超过 compactBudgetTokens 时，下一轮前丢弃较老的工具结果。
• 🇬🇧 Approval is enforced server-side (in the extension), not just UI. A model-issued write_file will not execute unless the policy or user explicitly allows it. 🇨🇳 审批在扩展端强制执行（不仅是 UI 层）：模型发出的 write_file 必须经策略或用户放行才会真的写盘。

📁 Project Structure · 项目结构

.
├── esbuild.config.js          # esbuild bundler config · 打包配置
├── package.json               # extension manifest + scripts · 清单与脚本
├── package-lock.json          # locked deps · 锁定依赖
├── README.md                  # this file · 本文件
├── LICENSE                    # MIT
├── media/                     # webview assets (loaded as static files)
│   ├── chat.css               #   ↳ all UI styles · 全部 UI 样式
│   └── chat.js                #   ↳ webview runtime (markdown, tool cards, streaming)
├── imgs/
│   ├── logo_black_bg.png      #   ↳ extension icon + webview logo
│   ├── logo_black_bg.svg      #   ↳ activity bar icon (vector)
│   ├── logo.png               #   ↳ marketplace icon (white background)
│   ├── logo_white_bg.svg      #   ↳ activity bar icon (white variant)
│   ├── logo_white_bg.png      #   ↳ logo (base)
│   └── screenshot.png         # README screenshot · README 截图
└── src/                       # extension source · 扩展源码
    ├── extension.js           #   ↳ activate() entry · 入口
    ├── errors.js              #   ↳ error → friendly bilingual card
    ├── logger.js              #   ↳ debug log writer (.deep-copilot/logs/)
    ├── pricing.js             #   ↳ token → CNY cost calculator
    ├── hooks.js               #   ↳ post-tool hooks runner (.deepcopilot/hooks.json)
    ├── mcp.js                 #   ↳ MCP stdio client (McpClient + McpManager)
    ├── api/
    │   └── deepseek.js        #   ↳ SSE chat client (OpenAI-compatible)
    ├── chat/
    │   ├── provider.js        #   ↳ ChatViewProvider (the brain)
    │   └── openFile.js        #   ↳ "open file at line" helper
    ├── prompts/
    │   └── system.js          #   ↳ system prompt builder (+DEEPCOPILOT.md +user memory)
    ├── tools/
    │   ├── schema.js          #   ↳ tool JSON-schema definitions
    │   └── exec.js            #   ↳ tool runtime (file IO, ripgrep, shell)
    ├── utils/
    │   ├── i18n.js            #   ↳ zh-cn / en strings + locale detection
    │   └── paths.js           #   ↳ path safety / workspace root resolution
    └── webview/
        └── html.js            #   ↳ generates the webview HTML shell

🇨🇳 编译入口：src/extension.js → esbuild → out/extension.js（package.json 中 main 字段指向 out/extension.js）。

🇬🇧 Build entry: src/extension.js → esbuild → out/extension.js (referenced by main in package.json).

💻 Development · 开发

Run the dev host · 启动扩展开发宿主

git clone https://github.com/ZhouChaunge/DeepCopilot.git
cd DeepCopilot
npm install
code .
# Press F5 inside VS Code → Extension Development Host opens
# 在 VS Code 里按 F5 → 弹出扩展开发宿主窗口

Live edit cycle · 改一改试一试

npm run watch     # esbuild watch — rebuilds on save · 保存即重建
# In the dev host: Ctrl+R / Cmd+R reloads the window after a rebuild
# 在宿主窗口里按 Ctrl+R / Cmd+R 重载即可看到效果

Debug logs · 调试日志

• Output panel → Deep Copilot channel Output 面板 → 选择 Deep Copilot 频道
• Or open via command palette: Deep Copilot: Open Debug Log 或命令面板：Deep Copilot: Open Debug Log
• Files: <workspace>/.deep-copilot/logs/session-*.log 日志文件：<工作区>/.deep-copilot/logs/session-*.log

Workspace-specific instructions · 工作区级提示词

Create a DEEPCOPILOT.md at the workspace root and Deep Copilot will inject its content into the system prompt for every request in this workspace — useful for project conventions, build commands, "do/don't" lists.

在工作区根目录新建 DEEPCOPILOT.md，其内容会自动并入系统提示词，用来声明项目约定、构建命令、do/don't 等。

User memory · 用户记忆

Create ~/.deepcopilot/memory.md for cross-project preferences that apply everywhere — preferred coding style, always/never rules, personal shortcuts. It is injected (capped at 4 KB) into every system prompt.

在家目录新建 ~/.deepcopilot/memory.md，写入跨项目的个人偏好（代码风格、禁忌事项等），Deep Copilot 会在每次对话时自动注入（最多 4KB）。

MCP servers · MCP 工具服务器

Add external tool servers via VS Code settings:

"deepseekAgent.mcp.servers": [
  { "name": "my-db", "command": "npx", "args": ["my-db-mcp-server"] }
]

Tools appear as mcp__my-db__<toolName> alongside built-in tools. Any MCP-compatible stdio server works.

通过 VS Code 设置连接外部 MCP 工具服务器，工具以 mcp__<server>__<toolName> 格式出现。任何兼容 MCP stdio 协议的服务器均可接入。

Post-tool hooks · 工具后置钩子

Create .deepcopilot/hooks.json in your workspace:

{ "hooks": [
  { "event": "after_tool", "tool": "write_file",
    "run": "npm test", "on_failure": "inject_error", "timeout_ms": 30000 }
]}

The hook's stdout/stderr is appended to the tool result so the model can react — e.g., auto-fix test failures immediately after writing a file.

在工作区创建 .deepcopilot/hooks.json，每次写文件后自动跑 npm test，测试输出注入模型上下文让其自动修复。

Style & conventions · 代码风格

• Plain JavaScript (no TypeScript) — keep the bundle tiny. 纯 JavaScript（不用 TypeScript），保持产物极小。
• No runtime dependencies — only VS Code API + Node built-ins. 无运行时依赖，只用 VS Code API 与 Node 内置模块。
• Webview side communicates via postMessage; never imports vscode. Webview 端通过 postMessage 通信，不引用 vscode。

🔧 Troubleshooting · 故障排查

📜 Changelog · 更新日志

v0.28.14 — UI Overhaul · UI 全面改版

• 🇬🇧 New branding: white whale logo on dark background, SVG vector activity bar icon.🇨🇳 全新品牌形象：黑底白色小鲸鱼 logo，活动栏矢量图标。
• 🇬🇧 Cleaner layout: top toolbar removed; API key 🔑 moved to footer bottom-right.🇨🇳 更简洁的布局：顶部工具栏移除，API Key 🔑 移至右下角底栏。
• 🇬🇧 Auto-grow textarea: input box grows with content, GH Copilot style (max 200px).🇨🇳 自适应输入框：随内容自动增高（对齐 GH Copilot 风格，最高 200px）。
• 🇬🇧 Stability fixes: activation crash from unescaped backtick in system prompt; JS null reference from removed DOM element. 🇨🇳 稳定性修复：系统提示词反引号导致的激活崩溃；DOM 元素删除后 JS 空引用。

v0.28.3 — HTML Rendering · Account Balance · v0.28.3

• 🇬🇧 HTML rendering in chat: model responses render full Markdown + HTML + KaTeX math.🇨🇳 HTML 渲染：响应支持完整 Markdown + HTML + KaTeX 数学公式。
• 🇬🇧 Account balance widget in footer: shows remaining DeepSeek credit, click to refresh.🇨🇳 账户余额：底栏实时显示 DeepSeek 余额，点击刷新。
• 🇬🇧 PR automation tooling improvements. 🇨🇳 PR 自动化工具改进。

v0.28.0 — MCP · Hooks · User Memory · Revert Last Turn

• 🇬🇧 MCP client (src/mcp.js): connect any MCP stdio tool server; tools appear as mcp__<server>__<tool>. Configure via deepseekAgent.mcp.servers.
• 🇨🇳 MCP 客户端（src/mcp.js）：连接任意 MCP stdio 工具服务器，工具以 mcp__<server>__<tool> 并列出现，通过 deepseekAgent.mcp.servers 配置。
• 🇬🇧 Post-tool hooks (src/hooks.js): run custom scripts after any tool call. Configure via .deepcopilot/hooks.json. Output injected into model context.
• 🇨🇳 工具后置钩子（src/hooks.js）：任意工具调用后自动执行用户脚本，输出注入模型上下文。
• 🇬🇧 User memory: ~/.deepcopilot/memory.md is injected (capped 4 KB) into every system prompt as "User preferences".
• 🇨🇳 用户记忆：~/.deepcopilot/memory.md（最多 4KB）注入每次对话的系统提示词。
• 🇬🇧 Revert last turn: revert_last_turn tool + deepseekAgent.revertLastTurn command — roll back all file changes from the current agent turn in one click.
• 🇨🇳 一键回滚：revert_last_turn 工具与 deepseekAgent.revertLastTurn 命令，一键撤销当前轮次所有文件改动。
• 🇬🇧 Post-edit LSP diagnostics: errors & warnings auto-appended after every file edit so the model can self-verify.
• 🇨🇳 编辑后 LSP 诊断：每次文件编辑后自动追加错误与警告，模型可据此自行修复。

v0.26.0 — Parallel tools · @file attach · apply_patch · Tool cache

• 🇬🇧 Multiple independent tool calls in one model turn (parallel execution). @filename attachment. apply_patch for multi-hunk edits. Tool result caching.
• 🇨🇳 单轮多工具并行执行；@文件名 附件；apply_patch 多 hunk 编辑；工具结果缓存。

v0.25.0 — Web search

• 🇬🇧 Added web_search tool powered by Tavily API.
• 🇨🇳 新增 web_search 工具，基于 Tavily API。

v0.24.2 — Flat tool UI · 工具卡片扁平化

• 🇬🇧 Tool rows are now hairline-bordered, no fill, GitHub-Copilot-Chat style.
• 🇨🇳 工具行改为细线分隔 + 无填充，接近 GitHub Copilot Chat 视觉。

v0.24.0 — Parallel sessions · 多会话并行

• 🇬🇧 Switch sessions while a run is in flight; events buffer and replay on return. Refactored into modular src/.
• 🇨🇳 任务运行中可切走开新对话，事件缓冲、切回自动回放；代码拆分为模块化 src/。

v0.20.0 — Copilot-grade UX overhaul

• 🇬🇧 Stop + Esc, blinking cursor, progress bar, code blocks with Run/Insert/Copy, syntax highlight, fold, hover bar, slash-commands, @ refs, prompt history, bilingual error cards.
• 🇨🇳 Stop + Esc 中断、闪烁光标、进度条、代码块操作、语法高亮、折叠、悬浮操作栏、斜杠命令、@ 上下文、↑/↓ 历史、双语错误卡。

Full history: see git log and Releases. 完整历史：见 git log 与 Releases。

📄 License

MIT © ZhouChaunge. See LICENSE.

_{🇨🇳 让高质量 AI 生产力开放、公平、普惠，触手可及。
🇬🇧 Make high-quality AI productivity open, fair, and affordable for everyone.}