docs: refresh root README and sync Chinese counterpart
Finalize the English root README (developer-preview notice, npm run path, community sections) and re-translate README.zh.md to match, updating the pairing record. Fix the README.md#run anchors in the Web UI guide and model providers docs after the Run section was renamed.
This commit is contained in:
Tianyi Cui
+2
-2
@@ -2,5 +2,5 @@
|
||||
# side as of the last confirmed-consistent state. Both languages carry equal authority;
|
||||
# after editing either side, bring the other along and re-record with:
|
||||
# pnpm run verify-translation-pairing --write README.md
|
||||
README.md: 891098974433535fa65863c80c512d3818e75955
|
||||
README.zh.md: d4b176737fffe60fe6393c796fe1d3e8cb9d72da
|
||||
README.md: 2218f59aede73dc692a3ddf6f80be9e6d9c31500
|
||||
README.zh.md: 42785fafa1bce7272eb1f0db2a9a6c46caaa92cd
|
||||
@@ -2,31 +2,27 @@
|
||||
|
||||
English | [中文](README.zh.md)
|
||||
|
||||
DeepSeek Harness (`dsh`) is an open-source coding agent and plugin-based agent harness.
|
||||
DeepSeek Harness (`dsh`) is an open-source agent harness developed by [DeepSeek AI](https://deepseek.com).
|
||||
|
||||
It uses an architecture where **everything is a plugin**.
|
||||
It is powered by [Cordis](https://github.com/cordiverse/cordis) and uses an architecture where **everything is a plugin**.
|
||||
|
||||
## Internal testing notice
|
||||
## Developer preview
|
||||
|
||||
DeepSeek Harness is under internal testing. Features and interfaces may change.
|
||||
DeepSeek Harness is currently in _developer preview_ and is iterating rapidly. **THERE WILL BE COMPATIBILITY-BREAKING CHANGES.**
|
||||
|
||||
Session Logs stay local by default. Set `DSH_TELEMETRY_MODE=FEEDBACK_ONLY` to share a Session Log only when submitting feedback, or `DSH_TELEMETRY_MODE=FULL` to upload continuously; `FULL` also enables dsh-sdk command telemetry reporting an anonymous ID, the command result, and redacted project configuration. Send feedback through the internal WeChat group.
|
||||
## Run from `npm`
|
||||
|
||||
## Run
|
||||
|
||||
Install Node.js ^22.19 or >= 24 and pnpm 11, then run the published package:
|
||||
Install `Node.js`, then run the published package:
|
||||
|
||||
```sh
|
||||
npx @deepseek-ai/dsh web
|
||||
```
|
||||
|
||||
The command initializes the Web profile and prints the Web UI URL, which is `http://127.0.0.1:3080` by default. Open it, add a DeepSeek API key under **Settings → Models**, then start a session. The invoking directory is the default workspace; try `Summarize this repository and identify its main packages.`
|
||||
|
||||
Continue with the [Web UI guide](docs/user/guide/index.md).
|
||||
The command starts the Web UI, served at `http://127.0.0.1:3080` by default. See [Web UI guide](docs/user/guide/index.md).
|
||||
|
||||
### Run from source
|
||||
|
||||
To run a repository checkout instead:
|
||||
To run from a repository checkout:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/deepseek-ai/deepseek-harness.git
|
||||
@@ -36,28 +32,23 @@ pnpm run build
|
||||
pnpm dsh web
|
||||
```
|
||||
|
||||
`pnpm run build` prepares the repository artifacts. `pnpm dsh web` starts the Web UI without rebuilding and opens the same path.
|
||||
## Community and support
|
||||
|
||||
## Profiles and plugins
|
||||
### Report bugs and suggest improvements
|
||||
|
||||
A profile is an ordered list of plugin bundles. The shipped `web` profile powers `dsh web`. Manage a profile with `dsh plugin --profile <name> <pnpm args>`, which forwards the remaining arguments to pnpm in that profile's directory:
|
||||
- Feel free to submit feedback or bug reports through [GitHub Discussions](https://github.com/deepseek-ai/deepseek-harness/discussions).
|
||||
|
||||
```sh
|
||||
npx -p @deepseek-ai/dsh dsh plugin --profile web add <package>
|
||||
npx -p @deepseek-ai/dsh dsh plugin --profile web remove <package>
|
||||
```
|
||||
### Share a plugin
|
||||
|
||||
`add`, `remove`, `update`, `why`, and other pnpm commands work unchanged. The command initializes a missing profile before changing its packages and updates its bundle list from installed packages that declare `dsh.bundle`. See the [CLI reference](apps/cli/reference/README.md#plugin-management) for the exact behavior.
|
||||
- Add the [`dsh-plugin`](https://github.com/topics/dsh-plugin) topic to your plugin repository for discoverability.
|
||||
|
||||
The [CLI reference](apps/cli/README.md) covers headless execution and custom profiles. The [Python SDK](python/README.md) and [examples](examples/README.md) cover programmatic and custom compositions.
|
||||
## Contributing
|
||||
|
||||
## Community
|
||||
|
||||
Follow <a href="https://x.com/Deepseekharness">DeepSeek Harness on Twitter</a> for project updates.
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
## Development
|
||||
|
||||
Start with the [development guide](docs/development.md) and read the [architecture](docs/architecture.md) before changing packages.
|
||||
Start with the [development guide](docs/development.md) and [architecture documentation](docs/architecture.md).
|
||||
|
||||
For agents, follow [AGENTS.md](AGENTS.md).
|
||||
|
||||
@@ -66,7 +57,3 @@ For agents, follow [AGENTS.md](AGENTS.md).
|
||||
[BSD 3-Clause](LICENSE)
|
||||
|
||||
Third-party dependencies and their licenses are disclosed in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
|
||||
|
||||
## Contributing
|
||||
|
||||
Read [CONTRIBUTING.md](CONTRIBUTING.md) before contributing to this repository.
|
||||
+16
-33
@@ -2,27 +2,23 @@
|
||||
|
||||
[English](README.md) | 中文
|
||||
|
||||
DeepSeek Harness（`dsh`）是一款开源 coding agent（编程智能体），也是一个基于插件的 agent harness（智能体框架）。
|
||||
DeepSeek Harness（`dsh`）是由 [DeepSeek AI](https://deepseek.com) 开发的开源 agent harness（智能体框架）。
|
||||
|
||||
它采用了**一切皆插件**的架构。
|
||||
它基于 [Cordis](https://github.com/cordiverse/cordis) 构建，采用**一切皆插件**的架构。
|
||||
|
||||
## 内测说明
|
||||
## 开发者预览
|
||||
|
||||
DeepSeek Harness 正处于内部测试阶段，功能和接口可能发生变化。
|
||||
DeepSeek Harness 目前处于 _开发者预览_ 阶段，正在快速迭代。**未来将出现破坏兼容性的变更。**
|
||||
|
||||
会话日志默认保存在本地。设置 `DSH_TELEMETRY_MODE=FEEDBACK_ONLY` 后，仅在提交反馈时共享对应的会话日志；设置 `DSH_TELEMETRY_MODE=FULL` 后，会持续上传会话日志。`FULL` 还会启用 dsh-sdk 命令遥测，上报匿名 ID、命令执行结果和脱敏后的项目配置。请通过内部企业微信群反馈问题和建议。
|
||||
## 通过 `npm` 运行
|
||||
|
||||
## 运行
|
||||
|
||||
请先安装 Node.js（版本要求：`^22.19` 或 `>=24`）和 pnpm 11，然后运行已发布的包：
|
||||
安装 `Node.js`，然后运行已发布的包：
|
||||
|
||||
```sh
|
||||
npx @deepseek-ai/dsh web
|
||||
```
|
||||
|
||||
该命令会初始化 Web profile 并打印 Web UI 地址，默认地址为 `http://127.0.0.1:3080`。打开该地址，在**设置 → 模型**中添加 DeepSeek API 密钥，然后启动一个会话。运行命令时所在的目录将作为默认工作区；你可以尝试输入 `Summarize this repository and identify its main packages.`。
|
||||
|
||||
下一步请阅读 [Web UI 指南](docs/user/guide/index.md)。
|
||||
该命令会启动 Web UI，默认地址为 `http://127.0.0.1:3080`。详见 [Web UI 指南](docs/user/guide/index.md)。
|
||||
|
||||
### 从源码运行
|
||||
|
||||
@@ -36,41 +32,28 @@ pnpm run build
|
||||
pnpm dsh web
|
||||
```
|
||||
|
||||
`pnpm run build` 会准备仓库产物。`pnpm dsh web` 不会重新构建，而是直接启动同一个 Web UI。
|
||||
## 社区与支持
|
||||
|
||||
## Profile 与插件
|
||||
### 反馈问题与提出改进建议
|
||||
|
||||
profile 由一组按顺序排列的插件组合包构成。随附的 `web` profile 用于运行 `dsh web`。使用 `dsh plugin --profile <name> <pnpm args>` 管理 profile；该命令会在对应 profile 目录中将剩余参数转发给 pnpm：
|
||||
- 欢迎通过 [GitHub Discussions](https://github.com/deepseek-ai/deepseek-harness/discussions) 提交反馈或 bug 报告。
|
||||
|
||||
```sh
|
||||
npx -p @deepseek-ai/dsh dsh plugin --profile web add <package>
|
||||
npx -p @deepseek-ai/dsh dsh plugin --profile web remove <package>
|
||||
```
|
||||
### 分享插件
|
||||
|
||||
`add`、`remove`、`update`、`why` 等 pnpm 命令均可直接使用。该命令会先初始化不存在的 profile，再修改其中的包，并根据声明了 `dsh.bundle` 的已安装包更新 bundle 列表。具体行为见 [CLI 参考](apps/cli/reference/README.md#plugin-management)。
|
||||
- 为你的插件仓库添加 [`dsh-plugin`](https://github.com/topics/dsh-plugin) 主题，便于被发现。
|
||||
|
||||
[CLI（命令行界面）参考](apps/cli/README.md)介绍 headless 执行与自定义 profile。[Python SDK](python/README.md) 和[示例](examples/README.md)介绍程序化组合与自定义组合。
|
||||
## 参与贡献
|
||||
|
||||
## 社区
|
||||
|
||||
扫描二维码，或打开 <a href="https://wj.qq.com/s2/27234598/03eb/">DeepSeek Harness 微信社区申请页面</a> 申请加入。
|
||||
|
||||
<p>
|
||||
<img src="assets/community-wecom-survey.png" alt="DeepSeek Harness 微信社区二维码" width="240">
|
||||
</p>
|
||||
参见 [CONTRIBUTING.md](CONTRIBUTING.md)。
|
||||
|
||||
## 开发
|
||||
|
||||
请先阅读[开发指南](docs/development.md)；修改包之前，请阅读[架构文档](docs/architecture.md)。
|
||||
请先阅读[开发指南](docs/development.md)与[架构文档](docs/architecture.md)。
|
||||
|
||||
面向 agent：遵循 [AGENTS.md](AGENTS.md)。
|
||||
面向 agent：请遵循 [AGENTS.md](AGENTS.md)。
|
||||
|
||||
## 许可证
|
||||
|
||||
[BSD 3-Clause](LICENSE)
|
||||
|
||||
第三方依赖及其许可证见 [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md)。
|
||||
|
||||
## 参与贡献
|
||||
|
||||
向本仓库贡献前，请阅读 [CONTRIBUTING.md](CONTRIBUTING.md)。
|
||||
@@ -2,5 +2,5 @@
|
||||
# side as of the last confirmed-consistent state. Both languages carry equal authority;
|
||||
# after editing either side, bring the other along and re-record with:
|
||||
# pnpm run verify-translation-pairing --write docs/user/guide/index.md
|
||||
index.md: 80d288b1aba37e7f0863fe5fc8237cbd2a6ab9b5
|
||||
index.zh.md: addfbc94ff93ed015e52f509a23a3f981e36770b
|
||||
index.md: fcf414baf0ee0b959d9cd2dfa128ccd138cfeb62
|
||||
index.zh.md: b4e80202c1555cfbff134a9db03ee92b1239f2ab
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
English | [中文](index.zh.md)
|
||||
|
||||
Start the Web UI through the [root README](../../../README.md#run); the command prints its URL. This guide begins after that server is running.
|
||||
Start the Web UI through the [root README](../../../README.md#run-from-npm); the command prints its URL. This guide begins after that server is running.
|
||||
|
||||
The invoking directory is the default workspace, so the agent can inspect and modify the project where you started `dsh`.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
[English](index.md) | 中文
|
||||
|
||||
先按照[根 README](../../../README.md#run)启动 Web UI；命令会打印其访问地址。本指南从服务器已经运行的状态开始。
|
||||
先按照[根 README](../../../README.md#run-from-npm)启动 Web UI；命令会打印其访问地址。本指南从服务器已经运行的状态开始。
|
||||
|
||||
调用目录是默认工作区，因此 agent（智能体）可以检查并修改启动 `dsh` 时所在的项目。
|
||||
|
||||
|
||||
@@ -2,5 +2,5 @@
|
||||
# side as of the last confirmed-consistent state. Both languages carry equal authority;
|
||||
# after editing either side, bring the other along and re-record with:
|
||||
# pnpm run verify-translation-pairing --write docs/user/guide/providers.md
|
||||
providers.md: 099f434ec4602aa402239e83c708d81fcadd7732
|
||||
providers.zh.md: 367c90b525ad628b3cd86b2d22045c25064e88a1
|
||||
providers.md: 191c5d441bd65d87832578d6c0a7b3771c3fec9f
|
||||
providers.zh.md: 5ff5ae88744eda1942b4b605bb6220d3b833987b
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
English | [中文](providers.zh.md)
|
||||
|
||||
This guide assumes you started the Web UI through the [root README](../../../README.md#run). Model changes take effect on the next request without restarting the server.
|
||||
This guide assumes you started the Web UI through the [root README](../../../README.md#run-from-npm). Model changes take effect on the next request without restarting the server.
|
||||
|
||||
## Configure DeepSeek
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
[English](providers.md) | 中文
|
||||
|
||||
本指南假定你已按照[根 README](../../../README.md#run)启动 Web UI。模型变更会在下一次请求时生效，不需要重启服务器。
|
||||
本指南假定你已按照[根 README](../../../README.md#run-from-npm)启动 Web UI。模型变更会在下一次请求时生效，不需要重启服务器。
|
||||
|
||||
## 配置 DeepSeek
|
||||
|
||||
|
||||
Reference in New Issue
Block a user