Import docs/README.md

This commit is contained in:
QQ 2026-11-17 08:38:58 +08:00
parent 89d86efd38
commit 38a5eb5c1b
1 changed files with 30 additions and 47 deletions

View File

@ -1,57 +1,40 @@
# DSH Remote 文档
## 当前仓库边界
## 使用与安装
本仓库只实现以下内容:
| 文档 | 用途 |
| --- | --- |
| [项目介绍](../README.zh.md)([English](../README.md)) | 功能、下载和快速开始 |
| [插件安装](installation.zh.md)([English](installation.md)) | profile、在线更新、CLI、Linux 服务与卸载 |
| [TUI 组合包](../packages/tui/README.md) | 终端 profile 的 Remote Host 与账号入口 |
| [版本兼容](compatibility.zh.md)([English](compatibility.md)) | 当前基线、旧 Host 边界与平台限制 |
| [最小自部署 Server](../apps/server/README.zh.md) | 单账号 Server 的配置、Docker 和运行方式 |
| [Remote Tools](remote-tools.md) | 本地 Harness 会话的远程工具注入开关 |
| [隐私政策](PRIVACY.md) | Browser Launcher 的数据处理范围 |
- DeepSeek Harness Plugin(常驻 Host + 本地 Remote 工作区入口,无用户可见的 Client 模式)
- Android Client(账号授权 + Adaptive transport + Typert Remote 数据面 + 可选 Codex Remote)
- VS Code Client(账号授权 + Host 信任固定 + rc.2 ApiProxy / v0.1.2 Typert Remote 会话/Prompt)
- Browser Chrome/Edge MV3 入口(独立设备凭据、在线 Host 列表、打开 Remote Web)
- `protocol`、`crypto`、`webrtc`、`client-core` 等共享包
- 已冻结的 Mock Host 互操作工具
## 后端与界面
本仓库另提供 [最小自部署 Server](../apps/server/README.zh.md):单账号环境变量鉴权、设备注册与凭据、Control/Relay,以及登录和设备状态页。
- [ACP 后端接入与实现](acp-remote.md):安装配置、后端差异、OpenCode 归档、gateway 和新增 adapter。
- [Codex 技术说明](codex-remote.md):App Server、Project/Thread authority 和内存投影。
- [Intelligent UI](intelligent-ui-android.md):可选离线 renderer 的构建和交互边界。
- [设计文档](design/README.md):产品边界、界面规则与专项实现设计。
完整多账号 Server、Remote Web 会话 UI 和 Admin 仍在独立 Server 项目实现;这里的最小版本复用相同协议子集,保持独立进程,不扩展为完整站点。
## 协议与安全
## 权威文档
| 文档 | 权威范围 |
| --- | --- |
| [Remote Protocol v1](protocol.md) | Host、Client、Server 的线协议 |
| [Host 插件接入](plugin-integration.md) | 账号、设备身份、凭据、迁移与刷新 |
| [端到端加密](end-to-end-encryption.md) | Noise、信任、密钥生命周期和可见元数据 |
| [网络与传输](network.md) | LAN/P2P/TURN/Relay、降级和恢复 |
| [设备配对](device-pairing-v1.md) | 协议、扫码与证明、关系授权及手机客户端接入 |
| [完整 Server 设计](server.md) | 独立站点的 API 与职责;不代表最小 Server 全部实现 |
- [Server 设计说明](server.md):定义外部 Server 的职责、API、安全边界、数据模型和部署要求;完整站点设计;最小自部署子集见上述运行文档。
- [Host Plugin 接入指南](plugin-integration.md):定义账号登录、Host 授权注册、设备凭证轮换、WebSocket 和本地状态隔离要求。
- [Remote Protocol v1](protocol.md):定义 Host、Server、Client 的线协议,是本仓库 Plugin、Client 和共享协议包的实现依据。
- [产品与功能设计](design/README.md):当前产品、Plugin、共享能力和界面设计;线协议以 protocol.md 为准。
## 维护
## 主题说明
- [TODO](TODO.md) 只保留待办与已知限制;版本变更写入 [CHANGELOG](CHANGELOG.md)。
- 当前版本和依赖以各包 manifest、lockfile 与源码为准;发布状态以正式 Release 为准。
- 协议变化同步 `protocol.md`、共享 schema 与消费端,不另建重复契约。
- 临时验收、发布评审、机器地址、日志、截图、单次构建的产物哈希及性能采样不放进长期文档目录。需要复现的操作保留在测试或工具 README,现场结果放 Issue/PR 或本地忽略目录。
- [开发任务与路线图](TODO.md):跟踪未完成的工作和验证边界。
- [更新记录](CHANGELOG.md):记录版本变更。
- [隐私说明](PRIVACY.md):说明数据处理与隐私边界。
- [插件安装指南](installation.zh.md)([English](installation.md)):已有 Harness 插件安装、Desktop 插件管理、profile 选择与插件卸载。
- [Codex Remote 技术说明](codex-remote.md):说明 Codex 工作区展示、数据边界、配置、安全限制和当前验证状态。
- [Agent 工作区接入指南](acp-integration.md):启用 Cursor / AGY / Pi / OpenCode / Claude / Codex,以及新增 ACP adapter 的接入点。
- [ACP Remote / Agent adapters](acp-remote.md):说明 Agent ACP gateway、后端 adapter、allowlist 与配置。
- [端到端加密](end-to-end-encryption.md):解释 Noise IK、设备身份固定、密钥生命周期、Server 可见元数据、重放保护与安全边界。
- [网络与传输](network.md):解释出站连接、Control/Data plane、LAN/P2P/TURN/Relay 选路、NAT、降级、断线恢复与当前验证状态。
- [版本兼容说明](compatibility.zh.md)([English](compatibility.md)):记录 Plugin 与各版本 DeepSeek Harness 的 carrier、Session 和 Desktop 兼容范围。
## 历史资料
以下仅用于追溯,不作为当前任务指令、兼容承诺或验收基线:
- [原始需求](archive/vibe-coding.md)。
## 阅读路径
- **项目介绍与快速开始**:默认入口为[English README](../README.md),中文版见[中文 README](../README.zh.md)。
- **在终端中使用 Remote**:当前版本只提供独立 CLI(`ds-harness-remote login|status|logout`)与浏览器/Desktop Host;dsh-TUI 集成计划在后续版本单独提供。
- **安装或使用其他 Plugin 入口**:先读[根 README](../README.md),再读[插件包说明](../packages/plugin/README.md)。
- **了解 Codex Remote 的实现边界**:先读[Codex Remote 技术说明](codex-remote.md),需要实现级字段时再查[协议](protocol.md)。
- **了解安全与网络边界**:先读[端到端加密](end-to-end-encryption.md)和[网络与传输](network.md),需要实现级字段时再查[协议](protocol.md)。
- **实现或审查 Plugin**:读[功能设计](design/plugin/functional-design.md)和[Host 接入指南](plugin-integration.md)。
- **实现外部 Server**:以[协议](protocol.md)为线协议权威,再参考[Server 设计](server.md)。
- **跟踪尚未完成的工作**:读[开发任务](TODO.md)。
文档优先级:`protocol.md` 的线协议约束高于示例代码;Server 设计发生变化时必须同步检查协议兼容性和版本号。
2026-09-20 原生侧栏扩展:官方文件树/只读预览、默认开启且可在详细 Remote 设置中关闭的终端,以及受限 loopback HTTP/WebSocket 预览,配置与边界见根 README,线协议见 `protocol.md`。完整 Server 仍只转发密文,不代理预览 HTTP 明文。
本仓库提供 Plugin、移动端、VS Code Client、Browser Launcher、共享包和单账号自部署 Server。完整多账号 Server、Remote Web 会话 UI 与 Admin 在独立仓库维护。Mock Host 是冻结的旧协议互操作工具,不作为新功能入口。