dc35fb8bbc
将原 6、测试 迁入 8、部署/05-测试验收，接口矩阵与开发日志并入 5、接口/06-验收与矩阵，项目总览与平台分析分别归位至 2、架构与 1、需求；同步 Obsidian、机擎规范与路径校验脚本。 Co-authored-by: Cursor <cursoragent@cursor.com>
61 lines
2.7 KiB
Markdown
61 lines
2.7 KiB
Markdown
# 工作手机 SDK v3.0（workphone-sdk）
|
||
|
||
存客宝 / 触客宝的 **AI 手机控制引擎**：统一控制微信等多 App，支持 **ADB / WebSocket Agent / Frida Hook** 多通道。
|
||
|
||
| 入口 | 地址 |
|
||
|------|------|
|
||
| **📖 完整整合手册（必读）** | [开发文档/9、手册/工作手机·五图总览与使用手册.md](开发文档/9、手册/工作手机·五图总览与使用手册.md) · `./开发文档/9、手册/open_handbook.sh` |
|
||
| **🗂️ 项目目录总览** | [开发文档/2、架构/01-总览/项目目录总览.md](开发文档/2、架构/01-总览/项目目录总览.md) |
|
||
| **本仓库（Gitea）** | http://open.quwanzhi.com:3000/fnvtk/workphone-sdk |
|
||
| **百科（Wiki）** | 仓库内同步源：`开发文档/8、部署/04-Gitea门户/wiki-gitea/` → 见下方「Wiki 同步」 |
|
||
| **本地 SDK 控制台（Hub）** | 启动服务后：`http://127.0.0.1:8899/hub` |
|
||
| **API 文档（Swagger）** | `http://127.0.0.1:8899/docs` |
|
||
|
||
## 一分钟结构
|
||
|
||
```
|
||
sdk/app/ # FastAPI 服务端、unified 路由、Hook 探测与数据 API
|
||
sdk/agent/ # 设备端 Agent + Frida Hook 脚本（wechat_hook_v2.js）
|
||
sdk/android-app/ # 设备端壳 APK（Gradle 构建）
|
||
开发文档/ # 需求、架构、部署、项目管理（权威文档）
|
||
机擎/ # 项目管理入口 SKILL.md
|
||
```
|
||
|
||
## 快速开始
|
||
|
||
```bash
|
||
cd sdk && pip install -r requirements.txt
|
||
cd app && python -m uvicorn main:app --host 0.0.0.0 --port 8899
|
||
# 浏览器打开 http://127.0.0.1:8899/hub
|
||
```
|
||
|
||
## Gitea：Actions / 百科 / 发行版 / 软件包
|
||
|
||
- **Actions**：`.gitea/workflows/sdk-ci.yml`（需 Gitea 管理员配置 `act_runner` 后才会跑绿）
|
||
- **百科正文**：`开发文档/8、部署/04-Gitea门户/wiki-gitea/*.md` — 用脚本或手动粘贴到 Gitea Wiki
|
||
- **发行版清单**：`开发文档/8、部署/04-Gitea门户/gitea/RELEASES.md` — 创建 Release 时对照上传资产
|
||
- **软件包说明**：`开发文档/8、部署/04-Gitea门户/gitea/PACKAGES.md`
|
||
- **项目看板建议**：`开发文档/8、部署/04-Gitea门户/gitea/PROJECTS.md`
|
||
|
||
一键同步 Wiki（推荐 `GITEA_TOKEN`；**勿把令牌写进仓库**）：
|
||
|
||
```bash
|
||
export GITEA_TOKEN='你的 Gitea 访问令牌'
|
||
python3 开发文档/8、部署/04-Gitea门户/gitea/publish_wiki.py
|
||
# 若未设变量，脚本会尝试从 git remote gitea 解析（本地开发机可用）
|
||
```
|
||
|
||
代码推送：
|
||
|
||
```bash
|
||
bash 开发文档/8、部署/03-运维同步/sync_to_gitea_github.sh
|
||
```
|
||
|
||
## 安全提醒
|
||
|
||
请勿在 `git remote` URL 中长期嵌入明文密码；请改用 **SSH** 或 **Personal Access Token + credential helper**，并轮换已泄露的凭据。
|
||
|
||
## 许可与说明
|
||
|
||
内部项目以团队约定为准；二次分发与商用请遵守微信等平台规则及当地法律。
|