Skip to content

Commit 99a19eb

Browse files
qorzjqorzj
committed
docs: update READMEs
1 parent 7862fa3 commit 99a19eb

7 files changed

Lines changed: 42 additions & 70 deletions

File tree

‎README-en.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -132,17 +132,13 @@ Deep Code supports the [official DeepSeek web search](https://api-docs.deepseek.
132132

133133
### Does it support Coding Plan?
134134

135-
Yes. Just set `env.BASE_URL` in `~/.deepcode/settings.json` to an OpenAI-compatible API endpoint. Take Volcano Ark's Coding Plan as an example:
135+
Yes. Just set `env.BASE_URL` in `~/.deepcode/settings.json` to an OpenAI-compatible API endpoint.
136136

137-
```json
138-
{
139-
"env": {
140-
"MODEL": "ark-code-latest",
141-
"BASE_URL": "https://ark.cn-beijing.volces.com/api/coding/v3",
142-
"API_KEY": "**************"
143-
},
144-
"thinkingEnabled": true
145-
}
137+
If you have a DeepCode Plus subscription, run `deepcode --plus`, paste your API Key and press Enter. The CLI will save the configuration automatically:
138+
139+
```bash
140+
$ deepcode --plus
141+
DeepCode Plus API Key: sk-··· (paste and press Enter)
146142
```
147143

148144
### How do I configure MCP?

‎README-zh_CN.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -147,17 +147,13 @@ Deep Code 支持 MCP（Model Context Protocol），可以连接 GitHub、浏览
147147

148148
### 是否支持 Coding Plan？
149149

150-
支持。只要把 `~/.deepcode/settings.json` 的 `env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。以火山方舟的 Coding Plan 为例：
150+
支持。只要把 `~/.deepcode/settings.json` 的 `env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。
151151

152-
```json
153-
{
154-
"env": {
155-
"MODEL": "ark-code-latest",
156-
"BASE_URL": "https://ark.cn-beijing.volces.com/api/coding/v3",
157-
"API_KEY": "**************"
158-
},
159-
"thinkingEnabled": true
160-
}
152+
如果使用 DeepCode Plus 的订阅套餐，可直接运行`deepcode --plus`，在提示后粘贴你的 API Key 并回车，CLI 会自动写入配置，无需手动编辑文件：
153+
154+
```bash
155+
$ deepcode --plus
156+
DeepCode Plus API Key: sk-···（粘贴后回车）
161157
```
162158

163159
## DeepCode Plus

‎README.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -147,17 +147,13 @@ Deep Code 支持 MCP（Model Context Protocol），可以连接 GitHub、浏览
147147

148148
### 是否支持 Coding Plan？
149149

150-
支持。只要把 `~/.deepcode/settings.json` 的 `env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。以火山方舟的 Coding Plan 为例：
150+
支持。只要把 `~/.deepcode/settings.json` 的 `env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。
151151

152-
```json
153-
{
154-
"env": {
155-
"MODEL": "ark-code-latest",
156-
"BASE_URL": "https://ark.cn-beijing.volces.com/api/coding/v3",
157-
"API_KEY": "**************"
158-
},
159-
"thinkingEnabled": true
160-
}
152+
如果使用 DeepCode Plus 的订阅套餐，可直接运行`deepcode --plus`，在提示后粘贴你的 API Key 并回车，CLI 会自动写入配置，无需手动编辑文件：
153+
154+
```bash
155+
$ deepcode --plus
156+
DeepCode Plus API Key: sk-···（粘贴后回车）
161157
```
162158

163159
## DeepCode Plus

‎packages/core/templates/skills/bundled/deepcode-self-refer/references/README.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -139,17 +139,13 @@ Deep Code 支持 MCP（Model Context Protocol），可以连接 GitHub、浏览
139139

140140
### 是否支持 Coding Plan？
141141

142-
支持。只要把 `~/.deepcode/settings.json` 的 `env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。以火山方舟的 Coding Plan 为例：
142+
支持。只要把 `~/.deepcode/settings.json` 的 `env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。
143143

144-
```json
145-
{
146-
"env": {
147-
"MODEL": "ark-code-latest",
148-
"BASE_URL": "https://ark.cn-beijing.volces.com/api/coding/v3",
149-
"API_KEY": "**************"
150-
},
151-
"thinkingEnabled": true
152-
}
144+
如果使用 DeepCode Plus 的订阅套餐，可直接运行`deepcode --plus`，在提示后粘贴你的 API Key 并回车，CLI 会自动写入配置，无需手动编辑文件：
145+
146+
```bash
147+
$ deepcode --plus
148+
DeepCode Plus API Key: sk-···（粘贴后回车）
153149
```
154150

155151
## 贡献

‎packages/vscode-ide-companion/README.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,13 @@ npm install -g @vegamo/deepcode-cli
7777

7878
### 是否支持Coding Plan？
7979

80-
支持。只要把`~/.deepcode/settings.json`的env.BASE_URL配置为OpenAI兼容的接口地址就行。以火山方舟的Coding Plan为例，`~/.deepcode/settings.json`这样配置：
80+
支持。只要把 `~/.deepcode/settings.json` 的 `env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。
8181

82-
```json
83-
{
84-
"env": {
85-
"MODEL": "ark-code-latest",
86-
"BASE_URL": "https://ark.cn-beijing.volces.com/api/coding/v3",
87-
"API_KEY": "**************"
88-
},
89-
"thinkingEnabled": true
90-
}
82+
如果使用 DeepCode Plus 的订阅套餐，可直接运行`deepcode --plus`，在提示后粘贴你的 API Key 并回车，CLI 会自动写入配置，无需手动编辑文件：
83+
84+
```bash
85+
$ deepcode --plus
86+
DeepCode Plus API Key: sk-···（粘贴后回车）
9187
```
9288

9389
## 获取帮助

‎packages/vscode-ide-companion/README_cn.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,13 @@ npm install -g @vegamo/deepcode-cli
7777

7878
### 是否支持Coding Plan？
7979

80-
支持。只要把`~/.deepcode/settings.json`的env.BASE_URL配置为OpenAI兼容的接口地址就行。以火山方舟的Coding Plan为例，`~/.deepcode/settings.json`这样配置：
80+
支持。只要把 `~/.deepcode/settings.json` 的 `env.BASE_URL` 配置为 OpenAI 兼容的接口地址就行。
8181

82-
```json
83-
{
84-
"env": {
85-
"MODEL": "ark-code-latest",
86-
"BASE_URL": "https://ark.cn-beijing.volces.com/api/coding/v3",
87-
"API_KEY": "**************"
88-
},
89-
"thinkingEnabled": true
90-
}
82+
如果使用 DeepCode Plus 的订阅套餐，可直接运行`deepcode --plus`，在提示后粘贴你的 API Key 并回车，CLI 会自动写入配置，无需手动编辑文件：
83+
84+
```bash
85+
$ deepcode --plus
86+
DeepCode Plus API Key: sk-···（粘贴后回车）
9187
```
9288

9389
## 获取帮助

‎packages/vscode-ide-companion/README_en.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -78,17 +78,13 @@ For detailed configuration instructions, see: https://binfer.net/share/jby5xnc-s
7878

7979
### Does it support Coding Plan?
8080

81-
Yes. Just set `env.BASE_URL` in `~/.deepcode/settings.json` to an OpenAI-compatible API endpoint. Take Volcano Ark's Coding Plan as an example, configure `~/.deepcode/settings.json` as follows:
81+
Yes. Just set `env.BASE_URL` in `~/.deepcode/settings.json` to an OpenAI-compatible API endpoint.
8282

83-
```json
84-
{
85-
"env": {
86-
"MODEL": "ark-code-latest",
87-
"BASE_URL": "https://ark.cn-beijing.volces.com/api/coding/v3",
88-
"API_KEY": "**************"
89-
},
90-
"thinkingEnabled": true
91-
}
83+
If you have a DeepCode Plus subscription, run `deepcode --plus`, paste your API Key when prompted, and press Enter. The CLI will save the configuration automatically, so there is no need to edit the file manually:
84+
85+
```bash
86+
$ deepcode --plus
87+
DeepCode Plus API Key: sk-··· (paste and press Enter)
9288
```
9389

9490
## Getting Help

0 commit comments

Comments
 (0)