cmshoppe/docs

项目文档导航

蝦皮圈優化助手（代号 cmshopee）的 harness coding 文档集合。agent 开始编程前从 00-ai-start-here.md 进入。

一句话定位

蝦皮圈優化助手（代号 cmshopee）是一个给电商运营使用的 Windows PySide6 桌面自动化工具，用于管理多个 Shopee 卖家账号、并用 CDP 驱动 Chrome 批量修改商品标题、替换商品封面图。V0 已验证单账号「改标题 + 换封面」闭环；当前 V1 目标是 5 Tab 流水线：导入采集 → AI 生成 → 点击「开始更新」并确认后批量提交 → 回写结果。

文档导航

• ../AGENTS.md：Codex / 通用 AI coding agent 的仓库级入口。
• ../CLAUDE.md：Claude Code 的薄入口，具体规则以 AGENTS.md 为准。
• ../progress.md：执行历史流水，只追加记录任务执行、验证、阻塞和决策。
• AI 开发入口：agent 每次开始工作的入口、阅读顺序和任务领取规则。
• 项目愿景：为什么做、为谁做、产品原则、非目标。
• 需求：要什么、用户故事、验收标准。
• 技术栈：语言、运行平台、CDP 方案、GUI 选型和运行命令。
• 架构设计：模块职责、账号与配置目录数据模型、CDP 已验证事实和开发顺序。
• 编码规则：写代码前必须遵守的硬约束。
• 任务文件：新任务入口——一任务一文件 docs/tasks/T-<编号>.md，避免多 agent 并发抢改同一文件、ID 撞号。
• 任务看板（历史归档）：T-000~T-549 历史任务，已冻结，不再新增。
• 模块 / CLI 合约：本地模块接口、Chrome 启动参数、账号配置 schema。
• 界面与流程结构：GUI 窗口、操作流程、按钮职责（无前端路由，用 GUI 流程替代）。
• 当前实现状态：当前代码现实、可运行命令、下一步可做任务。
• 常见问题排查：本地配置、启动报错、敏感文件修复等排障记录。
• 产品与 UI 评估：以 PM + UI 设计视角评估 5 Tab 模块 / 组件合理性，含优化方案与优先级清单。
• 界面配色设计：语义色板与组件配色映射规范，指导给状态 / 按钮 / 校验 / 登录状态上色。
• 工程评估：全栈视角评估工程基础设施与可维护性（依赖清单 / CI / 打包 / gui.py 拆分 / lint），含 P0-P2 与优先级。
• 打包与分发：PyInstaller 免安装 exe 打包命令、排除本地数据规则和用户手动更新方式。
• 对接 cmhub AI 网关设计：把生文/生图从本地直连改为对接 cmhub 计费网关的设计方案、改动边界与待确认问题。
• 版本检查接口契约：启动强制升级的服务端响应格式、客户端读取字段、强制规则与发版约定。

运行环境安装

python -m pip install -r requirements.txt
python -m pip install -r requirements-dev.txt
python -m ruff check app tests main.py
python -m compileall app main.py
python -m unittest discover -s tests
python -m pip install -r requirements-build.txt
powershell -ExecutionPolicy Bypass -File scripts\build_exe.ps1

requirements.txt 只锁定运行所需第三方依赖；requirements-dev.txt 锁定 ruff 等开发检查依赖；打包环境使用 requirements-build.txt 安装 PyInstaller；T-538 后 data/ 统一保存配置、SQLite、图片、登录态、日志、提示词和密钥，运营 Excel 仍是本地数据，不提交版本库。

GitHub Actions 工作流见 .github/workflows/tests.yml，在 push / pull_request 上使用 Windows + Python 3.11 安装 requirements.txt 与 requirements-dev.txt，并自动运行 ruff、语法检查和全量单元/GUI 测试。

任务 / 进度 / 当前状态

• 06-tasks.md 维护任务看板：任务 ID、依赖、验收要点和状态。
• ../progress.md 维护执行进度：每轮实际做了什么、跑了什么验证、遇到什么阻塞、做了什么决策。
• current-state.md 维护当前快照：当前目录、可运行命令、已完成摘要和下一个可领取任务。

维护原则

• 需求变化先改文档，再改代码。
• CDP 交互的关键事实（选择器、就绪判断、上传/拖拽方式）一旦定稿，写入 04-architecture.md，代码不得另起一套。
• 涉及账号、登录凭证、Cookie 时，文档与代码只用占位符或路径引用，绝不写入真实值。
• agent 开始新任务前，必须从 00-ai-start-here.md 进入。