docs: make Web UI the primary onboarding path

This commit is contained in:
Turtle
2026-08-12 10:59:06 +08:00
parent 50bedaf03b
commit 04fe477e7e
36 changed files with 190 additions and 844 deletions

View File

@@ -1,52 +1,28 @@
# 介绍
# 使用 Web UI
[English](index.md) | 中文
DeepSeek Harness 是一个**插件化的 agent智能体开发框架**,基于 [Cordis](https://github.com/cordiverse/cordis) 微内核构建。它的核心理念是:**一切皆插件**
先按照[根 README](../../../README.md#run)启动 Web UI命令会打印其访问地址。本指南从服务器已经运行的状态开始
## 它是什么
调用目录是默认工作区,因此 agent智能体可以检查并修改启动 `dsh` 时所在的项目。
Harness 将 AI人工智能 agent 所需的所有能力——LLM大语言模型调用、工具执行、会话管理、子任务分配——全部构建为可组合的插件。你通过一个 `cordis.yml` 配置文件来声明加载哪些插件、使用什么参数,就能组装出一个完整的 agent。
## 配置模型
```yaml
# Select the LLM backend
- name: '@deepseek-ai/dsh-llm-deepseek'
打开**设置 → 模型**,输入 DeepSeek API 密钥并保存。模型路由会立即可用,不需要重启服务器。
# Compose one configured agent
- id: agent-spine
name: '@deepseek-ai/dsh-agent-spine-demo'
config:
agents:
- id: main
provider: deepseek-official
model: deepseek-v4-flash
workspaceContext: false
```
[模型配置指南](./providers.md)介绍其他提供方和自定义 OpenAI 兼容端点。
## 适合谁
## 运行任务
### 应用使用者
启动一个会话并发送:
如果你只是想用一个现成的 agent 应用(如编程助手、对话代理),你需要的全部操作就是:
> Summarize this repository and identify its main packages.
1. 复制一个示例模板
2. 填写 API 密钥。
3. 运行。
agent 可以读取和编辑工作区文件、运行命令、委派工作并维护计划。当操作在当前权限策略下需要审批时Web UI 会先询问你
不需要写任何代码。详见 [快速开始](./quickstart.md)。
## 继续使用
### 插件开发者
如果你想为 agent 添加新能力——一个自定义工具、一个新的 LLM 适配器、一个新的执行后端——你需要编写一个插件。Harness 提供了清晰的扩展接口和类型安全的开发体验。详见 [开发](../develop/basic/)
## 核心功能
- **只需要配置** — `cordis.yml` 决定能力集合,换模型、加工具只需改一行
- **HMR热模块替换** — 开发时修改插件代码,无需重启进程
## 技术栈
- **运行时**Node.js ^22.19 或 >= 24
- **语言**TypeScriptESM
- **框架**Cordis
- **包管理**pnpm workspaces仓库固定使用 pnpm 11
- [配置模型](./providers.md)
- [使用 Python SDK](./python-sdk.md)
- [使用其他 CLI 模式](../../../apps/cli/README.md)
- [开发插件](../develop/basic/)