Skip to content

docs: update the GitHub Copilot integration guide #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
idranme wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update the GitHub Copilot integration guide #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
57 changes: 57 additions & 0 deletions docs/github_copilot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,63 @@

# Integrate with GitHub Copilot

## Integrate via Official BYOK
BYOK stands for *bring your own language model API key*, which allows you to use models not built into Copilot with or without signing in to GitHub. VS Code has supported BYOK without GitHub sign-in since version 1.122.

#### 1. Get a DeepSeek API Key

- Go to [DeepSeek Platform](https://platform.deepseek.com/api_keys) and create an API key.
- Copy the key (it starts with `sk-`).

#### 2. Configure the API Key in VS Code

- Open the Command Palette (`Cmd+Shift+P` / `Ctrl+Shift+P`).
- Run **Chat: Manage Language Models**.
- In the pop-up window, click **Add Models**, select **Custom Endpoint**, then enter "DeepSeek" in the Group Name field, paste your DeepSeek API Key in the API Key field, and select **Chat Completions** as the API Type.
- After completing the previous step, a `chatLanguageModels.json` editor will open. Replace the **models** field with the following:

```json
[
{
"id": "deepseek-v4-flash",
"name": "DeepSeek V4 Flash",
"url": "https://api.deepseek.com",
"toolCalling": true,
"vision": false,
"thinking": true,
"maxInputTokens": 1000000,
"maxOutputTokens": 384000,
"supportsReasoningEffort": [
"high",
"max"
]
},
{
"id": "deepseek-v4-pro",
"name": "DeepSeek V4 Pro",
"url": "https://api.deepseek.com",
"toolCalling": true,
"vision": false,
"thinking": true,
"maxInputTokens": 1000000,
"maxOutputTokens": 384000,
"supportsReasoningEffort": [
"high",
"max"
]
}
]
```

#### 3. Select the Model and Start Chatting

- Open Copilot Chat (`Cmd+Shift+I` / `Ctrl+Shift+I`).
- Click the model picker at the bottom of the chat panel.
- Choose **DeepSeek V4 Pro** or **DeepSeek V4 Flash**.
- Start chatting — agent mode, tool calling, and all Copilot features work out of the box.

## Integrate via Community Extension

**DeepSeek V4 for Copilot Chat** is a VS Code extension that adds DeepSeek V4 Pro & Flash directly into the GitHub Copilot Chat model picker. You keep Copilot's agent mode, tool calling, skills, and MCP — all powered by DeepSeek.

#### 1. Install the Extension
Expand Down
57 changes: 57 additions & 0 deletions docs/github_copilot.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,63 @@

# 接入 GitHub Copilot

## 通过官方 BYOK 接入
BYOK 指 *bring your own language model API key*，该功能可使我们在不登录或登录 GitHub 的情况下使用未内置的模型。VS Code 从 1.122 版本开始支持在不登录 GitHub 的情况下使用 BYOK。

#### 1. 获取 DeepSeek API Key

- 前往 [DeepSeek 开放平台](https://platform.deepseek.com/api_keys) 创建 API Key。
- 复制 Key（以 `sk-` 开头）。

#### 2. 在 VS Code 中配置 API Key

- 打开命令面板（`Cmd+Shift+P` / `Ctrl+Shift+P`）。
- 执行 **Chat: Manage Language Models**。
- 在新弹出的窗口中点击 **Add Models**，选择 **Custom Endpoint**，然后在 Group Name 输入框填入「DeepSeek」，在 API Key 输入框填入 DeepSeek API Key，在 API Type 选择框选中「Chat Completions」。
- 完成上一步后，会弹出 chatLanguageModels.json 编辑框，将该 JSON 的 **models** 字段更改为以下内容：

```json
[
{
"id": "deepseek-v4-flash",
"name": "DeepSeek V4 Flash",
"url": "https://api.deepseek.com",
"toolCalling": true,
"vision": false,
"thinking": true,
"maxInputTokens": 1000000,
"maxOutputTokens": 384000,
"supportsReasoningEffort": [
"high",
"max"
]
},
{
"id": "deepseek-v4-pro",
"name": "DeepSeek V4 Pro",
"url": "https://api.deepseek.com",
"toolCalling": true,
"vision": false,
"thinking": true,
"maxInputTokens": 1000000,
"maxOutputTokens": 384000,
"supportsReasoningEffort": [
"high",
"max"
]
}
]
```

#### 3. 选择模型并开始对话

- 打开 Copilot Chat（`Cmd+Shift+I` / `Ctrl+Shift+I`）。
- 点击聊天面板下方的模型选择器。
- 选择 **DeepSeek V4 Pro** 或 **DeepSeek V4 Flash**。
- 即可开始对话 — Agent 模式、工具调用及所有 Copilot 功能均可直接使用。

## 通过社区插件接入

**DeepSeek V4 for Copilot Chat** 是一个 VS Code 插件，将 DeepSeek V4 Pro 和 Flash 直接添加到 GitHub Copilot 的模型选择器中。你仍可使用 Copilot 的 Agent 模式、工具调用、Skills 和 MCP — 全部由 DeepSeek 驱动。

#### 1. 安装插件
Expand Down