开发者架构概览
本章帮助开发者判断扩展入口和交付前检查项。当前操作手册仓库只包含 Docusaurus 文档站,不包含东创龙虾面板桌面应用源码,因此无法从本仓库验证旧文档中列出的 Electron、IPC、数据库或具体源码路径。
源码边界
取得与目标安装包一致的桌面应用源码、提交号、依赖锁文件和构建说明前,不要按网上示例或旧路径直接修改生产版本。
二次开发前必须取得
| 资料 | 用途 |
|---|---|
| 源码仓库和精确提交号 | 保证代码与目标安装包一致 |
| Node、包管理器和系统依赖版本 | 复现开发与打包环境 |
| 环境变量和本地服务说明 | 区分开发配置与真实凭据 |
| 数据目录、配置格式和迁移策略 | 避免升级破坏用户数据 |
| IPC / API / 插件接口定义 | 确认前后端边界和权限 |
| 测试账号与演示数据 | 验证模型、IM、MCP 和授权流程 |
| 发布、签名和回滚流程 | 生成可验证的安装包 |
如果资料缺少,应先向项目维护者确认,而不是在手册中补写推测路径。
从产品界面可确认的模块
当前界面能够确认以下业务边界:
- 对话与 Agent 页签:OpenClaw、Hermes Agent、Claude Code、Codex。
- 定时任务:保存并按计划触发已经验证的任务。
- 软件商店:管理 Agent、运行环境和工具。
- 技能管理:安装、添加和启停 Skill。
- MCP 工具:市场、已安装和自定义服务。
- AI 模型:提供商、认证、接口格式和模型列表。
- 安全防护:文件夹锁、敏感文件夹及其他安全入口。
- 日志中心、实例管理、设置、登录、授权许可和技术支持。
这些是产品功能入口,不等同于稳定的源码 API。内部模块名称和目录仍以对应版本源码为准。
扩展 Skill
不修改桌面应用源码时,优先使用 技能管理 的“添加”入口:
- 明确技能输入、输出、依赖和最小权限。
- 使用非敏感测试目录验证。
- 在实际目标 Agent 中确认能够发现和调用。
- 记录 Skill 版本、来源和回滚方式。
- 涉及文件、网络或程序执行时完成安全审查。
需要增加新的安装格式或权限机制时,再进入源码开发流程。
扩展 MCP
优先使用 MCP 工具管理 的市场或自定义入口。开发服务时至少验证:
- 初始化和工具列表能够被面板读取。
- 传输方式与当前面板及目标 Agent 兼容。
- 凭据使用最小权限,不写入日志。
- 失败、超时和服务退出时能够被诊断。
- 停用后外部 Token 可以撤销。
接入模型提供商
先尝试 AI 模型管理 中的预设提供商或 Custom:
- 核对 OAuth/API Key、Base URL 和接口兼容格式。
- 使用“测试连接”验证认证。
- 添加准确模型 ID,并在每个目标 Agent 中测试。
- 只有现有配置无法表达服务商能力时,才修改源码增加提供商类型。
源码改动流程
- 01定位版本与场景记录目标版本和用户场景。
- 02边界找入口与边界定位实际入口、状态存储和跨进程/网络边界。
- 03权限先补权限模型先补失败场景和权限模型,再修改实现。
- 04验证数据验证用测试数据执行单元、集成和端到端验证。
- 05兼容升级与恢复验证升级、卸载、备份恢复和旧配置兼容。
- 06发布签名发布生成签名安装包,在干净与升级设备分别测试。
- 07文档更新操作手册更新操作手册截图和版本说明。
取得完整源码后,每项修改都应遵循:
- 记录目标版本和用户场景。
- 找到实际入口、状态存储和跨进程/网络边界。
- 先补失败场景和权限模型,再修改实现。
- 用测试数据执行单元、集成和端到端验证。
- 验证升级、卸载、备份恢复和旧配置兼容性。
- 生成签名安装包,在干净设备和升级设备上分别测试。
- 更新操作手册截图和版本说明。
发布验收矩阵
产品目标覆盖 macOS、Linux、Windows 和便携运行场景;当前公开安装流程只验证 Windows。发布某个平台前应分别确认:
- 安装、首次启动、运行环境检测和卸载。
- 模型、Agent、实例、Skill、MCP 和 IM 集成。
- 本地文件权限、加密、安全防护和日志。
- 升级、回滚、配置迁移和数据恢复。
- 安装包签名、校验值和下载地址。
没有完成上述矩阵的平台应标为待发布,不能只根据代码能够编译就宣称可用。
文档站开发
如果目标只是维护本操作手册,请在 dc-openclaw-panel/ 目录执行:
yarn install
yarn start
yarn run check
文档站技术栈和目录说明见项目根目录的 README.md;它与桌面应用源码是两个独立范围。