docs: make the top-level README product-first

This commit is contained in:
Tianyi Cui
2026-07-23 00:15:44 +08:00
parent 30a1ea7cec
commit ef325b02fa
14 changed files with 172 additions and 635 deletions

View File

@@ -2,32 +2,74 @@
[English](README.md) | 中文
**DeepSeek Harness SDK** 是用于构建 agent harness智能体框架的 SDK采取基于插件的设计
DeepSeek Harness`dsh`)是一款基于 DeepSeek Harness SDK 构建的开源 coding agent编程智能体一切皆插件
## 安装
一行命令即可安装 `dsh` 编码智能体——需要 `git` 和 Node `^22.19 || >=24`,缺少 `pnpm`会询问是否代为安装
使用一条命令安装 `dsh`。安装器要求系统已安装 `git` 和 Node `^22.19 || >=24`,缺少 `pnpm`可代为安装,并会提示输入 DeepSeek API 密钥
```sh
curl -fsSL https://raw.githubusercontent.com/deepseek-harness/deepseek-harness/master/scripts/install.sh | sh
```
脚本会把 harness 克隆到 `~/.dsh/source`运行 `pnpm install``dsh` 链接到 `~/.local/bin`(并询问是否加入 PATH提示输入一次 `DEEPSEEK_API_KEY`,随后启动 `dsh`;再次运行会更新已有的检出。若在检出目录内运行(`sh scripts/install.sh`),脚本会复用当前检出并跳过克隆。可覆盖的 `DSH_*` 变量见 [`scripts/install.sh`](scripts/install.sh)。
安装器会将 DeepSeek Harness 克隆到 `~/.dsh/source`,把 `dsh` 链接到 `~/.local/bin`,然后启动它。再次运行该命令会更新源码目录。其他安装位置和选项见 [`scripts/install.sh`](scripts/install.sh)。
## 使用 DeepSeek Harness
### Web UI
推荐在本地使用 Web UI。安装完成后以及每次更新后请先构建前端再启动 Web UI
```sh
pnpm --dir ~/.dsh/source run build:web
dsh web
```
Web UI 默认通过 `http://127.0.0.1:3080` 提供服务。
### TUI
启动全屏终端界面:
```sh
dsh
```
### Headless
运行一项任务,打印最终答案后退出:
```sh
dsh -p "summarize this workspace"
```
## 为什么选择 DeepSeek Harness
内置功能涵盖文件读取、编辑与搜索、shell 执行、可复用 skill技能、任务跟踪、subagent 与工作流、持久化会话以及上下文压缩context compaction。TUI 还包含 Plan Mode。
- **一切皆插件。** 模型、工具、策略、存储、上下文管理和界面均可组合为 [Cordis 插件](docs/user/develop/basic/index.md),部署方无需 fork agent loop智能体循环即可扩展或替换行为。底层设计见[架构文档](docs/architecture.md)。
- **Code Mode 需显式启用。** 它会提供 `run_code` 工具和生成的 TypeScript SDK只有程序输出会重新进入模型上下文。参见 [Code Mode](packages/core/tools/README.md#code-mode)。
- **自指 Cordis 工具需显式启用。** 这些工具可让 agent 检查自身的实时运行时,并在运行中挂载或卸载插件。参见 [Cordis 工具](packages/cordis/tool-cordis/README.md)。
## 社区
扫描二维码加入 DeepSeek Harness 微信社区。
<p>
<img src="assets/community-wecom-survey.png" alt="DeepSeek Harness 微信社区二维码" width="240">
</p>
## 开发
本 monorepo 基于 [Cordis](https://github.com/cordiverse/cordis) 框架构建(以源码形式收录在 `vendor/` 下),采用微内核风格:所有功能都以插件形式提供。
```sh
pnpm install
pnpm run test # vitest
# Agent demos require DEEPSEEK_API_KEY.
pnpm run demo:tui # full-screen TUI coding agent
pnpm run demo:headless "task" # one-shot coding agent
pnpm run demo:cordis # self-referential agent demo
pnpm run demo:acp # ACP server agent demo
pnpm run test:coverage
```
面向开发者:先读[开发指南](docs/development.md),了解本地环境搭建、钩子、环境变量与质量门禁,动手改 package 之前再读[架构设计](docs/architecture.md)和[文档关系图索引](docs/graph-atlas.md)。局部上下文见 [packages/](packages/) 与 [vendor/](vendor/)。
请先阅读[开发指南](docs/development.md);修改包之前,请阅读[架构文档](docs/architecture.md);在本仓库工作时,请遵循 [AGENTS.md](AGENTS.md)。
面向 agent遵循 [AGENTS.md](AGENTS.md)。
DeepSeek Harness 目前处于预发布阶段。
## 许可证
[BSD 3-Clause](LICENSE)