diff --git a/.gitignore b/.gitignore index 5802e9b..5e23f60 100644 --- a/.gitignore +++ b/.gitignore @@ -35,6 +35,11 @@ yarn-error.log* # Generated local documents *.docx +# Generated screenshots and local visual captures +screenshot/ +screenshots/ +resources/readme/ + # OS files .DS_Store Thumbs.db diff --git a/README.md b/README.md index d3701f2..f154301 100644 --- a/README.md +++ b/README.md @@ -27,41 +27,27 @@ 当前项目来源于 ClawX 开源桌面端能力，并在此基础上进行了产品化改造：品牌更名为“智念助手”，重构了登录、组织空间、首页、应用中心、能力包、知识库、设置、初始化、打包与运行时依赖链路。 -当前阶段：`3.5` 内测研发阶段。 +当前版本：`0.1.24` 正式版。仓库默认分支 `main` 保持最新可运行代码，正式发布标签 `v0.1.24` 对应当前发布版本。 -## 功能截图 +## 快速安装使用最新版 -### 登录 +适合客户、测试人员或交付同事从仓库直接启动最新版本： -![登录与组织空间](resources/readme/01-login.png) +```bash +git clone https://git.nianxx.cn/wangxuming/NianToB.git yinian-desktop +cd yinian-desktop +git checkout main +git pull --ff-only +corepack enable +pnpm install +cp .env.example .env.local +printf "\nYINIAN_CONTROL_PLANE_MODE=mock\n" >> .env.local +pnpm dev +``` -### 首次初始化 +开发模式会启动 Vite 与 Electron，并由桌面端管理本地 Host API 与 OpenClaw Gateway。离线演示模式不需要真实服务端凭据；如果需要连接真实组织空间，请从部署负责人处获取服务地址和 OAuth 客户端配置，写入本机 `.env.local`。 -![首次初始化](resources/readme/02-setup.png) - -### 工作台首页 - -![工作台首页](resources/readme/03-home.png) - -### 对话与快捷任务 - -![对话与快捷任务](resources/readme/04-chat-quick-task.png) - -### 知识库 - -![知识库](resources/readme/07-knowledge.png) - -### 定时任务 - -![定时任务](resources/readme/08-cron.png) - -### 能力包与快捷任务配置 - -![能力包与快捷任务配置](resources/readme/09-settings-skills.png) - -### 渠道管理 - -![渠道管理](resources/readme/10-settings-channels.png) +仓库只保留 `.env.example` 占位模板，不提交真实 API key、token、client secret、证书或客户专属服务端点。 ## 核心能力 @@ -73,7 +59,7 @@ - **定时任务**：面向用户可见、可管理的自动化任务能力，与 OpenClaw 内部 heartbeat 机制分离。 - **渠道管理**：支持渠道和账号绑定，渠道账号可维护备注；新增渠道时会自动创建对应 Agent，删除渠道时同步清理绑定 Agent。 - **应用中心**：保留固定业务应用入口；当前不再内置业务应用，后续由产品交付节奏重新接入。 -- **初始化流程**：首次打开时引导安装或重装 OpenClaw 运行环境，并内置内测阶段模型配置与必要依赖。 +- **初始化流程**：首次打开时引导安装或重装 OpenClaw 运行环境，并准备必要依赖；模型 API 与服务端配置通过本机环境或服务端下发，不随仓库提交。 - **运行维护**：管理员模式下提供模型配置诊断、Gateway 状态、OpenClaw 运行信息和高级排查入口。 ## 技术栈 @@ -108,25 +94,6 @@ yinian-desktop/ ## 本地开发 -### 快速开始 - -面向客户或测试人员的最快路径： - -```bash -git clone <仓库地址> -cd yinian-desktop -pnpm install -cp .env.example .env.local -``` - -如果只是体验桌面外壳和本地能力，可以在 `.env.local` 中启用离线演示模式： - -```bash -YINIAN_CONTROL_PLANE_MODE=mock -``` - -如果需要连接真实组织空间，请从部署负责人处获取服务地址和 OAuth 客户端配置，写入本机 `.env.local`。仓库只保留 `.env.example` 占位模板，不提交真实 API key、token、client secret、证书或客户专属服务端点。 - ### 环境要求 - Node.js 20+ @@ -155,37 +122,39 @@ pnpm test pnpm run build:vite ``` -### 内测打包 +### 正式打包 -macOS Apple Silicon 内测包： +macOS Apple Silicon 正式包： ```bash -pnpm run package:mac:pilot:arm64 +pnpm run prep:mac-binaries:arm64 +pnpm run package +pnpm exec electron-builder --mac --arm64 --publish never ``` -通用 macOS 内测包： +通用 macOS 正式包： ```bash -pnpm run package:mac:pilot +pnpm run package:mac ``` 打包前脚本会准备 OpenClaw runtime、OpenClaw plugins、预装能力包、Node/uv 等必要运行资源。 -如果没有私有模型凭据或客户专属服务配置，建议先使用普通开发模式或非 pilot 打包；真实密钥应只通过 CI Secret、本机环境变量或服务端下发进入运行时，不应进入 git 仓库。 +真实密钥应只通过 CI Secret、本机环境变量或服务端下发进入运行时，不应进入 git 仓库。 ## 运行时说明 - 智念助手会优先使用桌面端托管的 OpenClaw runtime。 -- 内测阶段会在初始化流程中重装并修正 OpenClaw 配置，减少客户本机历史环境影响。 +- 初始化流程会安装并修正 OpenClaw 配置，减少客户本机历史环境影响。 - OpenClaw agent heartbeat 已在智念托管配置中关闭，自动化任务统一使用智念助手的“定时任务”功能。 -- 更新能力当前以服务端下发为目标，内测包不应依赖 ClawX 原始 GitHub Release。 +- 更新能力当前以服务端下发为目标，正式包不依赖 ClawX 原始 GitHub Release。 - 真实服务端地址、账号、权限、密钥和计费后续由服务端统一管理，桌面端不暴露正式凭证。 ## 服务端接口 当前已接入账号密码登录，并预留组织空间、能力包下发、渠道与应用服务等服务端协作边界。 -内测阶段如果服务端能力尚未完整提供，桌面端会保留必要的本地兜底逻辑，以保证安装、初始化、对话、知识库与应用中心可测试。 +如果服务端能力尚未完整提供，桌面端会保留必要的本地兜底逻辑，以保证安装、初始化、对话、知识库与应用中心可测试。 ## 验证重点 @@ -206,8 +175,8 @@ pnpm run package:mac:pilot 智念助手使用 OpenClaw 作为 Agent 运行内核，并参考了 ClawX 的桌面端工程基础。当前仓库已经面向智念助手产品目标进行定制开发，不再作为原 ClawX 通用客户端维护。 -后续如果同步上游 OpenClaw 或 ClawX 的能力，需要以智念助手的产品边界、普通企业用户体验和内测交付稳定性为优先。 +后续如果同步上游 OpenClaw 或 ClawX 的能力，需要以智念助手的产品边界、普通企业用户体验和正式交付稳定性为优先。 ## License -本项目基于 MIT License 的开源工程进行二次开发。内部业务代码、品牌素材、服务端协议与内测配置请按团队协作规范使用。 +本项目基于 MIT License 的开源工程进行二次开发。内部业务代码、品牌素材、服务端协议与交付配置请按团队协作规范使用。 diff --git a/resources/readme/01-login.png b/resources/readme/01-login.png deleted file mode 100644 index 6beb828..0000000 Binary files a/resources/readme/01-login.png and /dev/null differ diff --git a/resources/readme/02-setup.png b/resources/readme/02-setup.png deleted file mode 100644 index c351e40..0000000 Binary files a/resources/readme/02-setup.png and /dev/null differ diff --git a/resources/readme/03-home.png b/resources/readme/03-home.png deleted file mode 100644 index b073f61..0000000 Binary files a/resources/readme/03-home.png and /dev/null differ diff --git a/resources/readme/04-chat-quick-task.png b/resources/readme/04-chat-quick-task.png deleted file mode 100644 index 496eb26..0000000 Binary files a/resources/readme/04-chat-quick-task.png and /dev/null differ diff --git a/resources/readme/07-knowledge.png b/resources/readme/07-knowledge.png deleted file mode 100644 index c6b781e..0000000 Binary files a/resources/readme/07-knowledge.png and /dev/null differ diff --git a/resources/readme/08-cron.png b/resources/readme/08-cron.png deleted file mode 100644 index e66253c..0000000 Binary files a/resources/readme/08-cron.png and /dev/null differ diff --git a/resources/readme/09-settings-skills.png b/resources/readme/09-settings-skills.png deleted file mode 100644 index d7a6b5e..0000000 Binary files a/resources/readme/09-settings-skills.png and /dev/null differ diff --git a/resources/readme/10-settings-channels.png b/resources/readme/10-settings-channels.png deleted file mode 100644 index 1117aaa..0000000 Binary files a/resources/readme/10-settings-channels.png and /dev/null differ