Files
cmshoppe/AGENTS.md
T

58 lines
3.8 KiB
Markdown
Raw Normal View History

# AGENTS.md
> Codex / 通用 AI coding agent 的仓库级入口。进入本仓库后,先读本文,再进入 [`docs/00-ai-start-here.md`](docs/00-ai-start-here.md)。
## 项目定位
2026-07-07 09:52:51 +08:00
蝦皮圈優化助手(代号 cmshopee)是一个 **Windows 本地桌面自动化工具**:管理多个 Shopee 卖家账号,用 CDP 驱动 Chrome 自动改商品标题、换商品封面。当前单账号流程已验证,正在扩展多账号管理与 GUI。
## 文档位置
- 项目文档集合在 [`docs/`](docs/),导航见 [`docs/README.md`](docs/README.md)。
- 编程入口是 [`docs/00-ai-start-here.md`](docs/00-ai-start-here.md),它继续导航到愿景、需求、技术栈、架构、编码规则、任务看板。
- 执行历史流水在根目录 [`progress.md`](progress.md);当前快照在 [`docs/current-state.md`](docs/current-state.md)。
## 必读顺序
每次开始工作前,按顺序读取:
1. 本文 `AGENTS.md`:仓库定位与规则。
2. [`docs/00-ai-start-here.md`](docs/00-ai-start-here.md):编程入口与流程。
2026-06-26 15:55:28 +08:00
3. [`docs/04-architecture.md`](docs/04-architecture.md):尤其**第七节 CDP 已验证事实**。
4. [`docs/05-coding-rules.md`](docs/05-coding-rules.md):硬性编码规则。
5. [`docs/06-tasks.md`](docs/06-tasks.md) + [`docs/current-state.md`](docs/current-state.md):领取任务、了解现状。
6. 与当前任务相关的具体文档。
## 工作规则
2026-06-26 17:05:18 +08:00
- 正式代码统一放入 `app/` 包;迁移完成后复用 `app/cdp.py`,遵守架构第七节的选择器、就绪判断、上传/拖拽方式,不另起一套 CDP 交互。
2026-06-29 14:37:09 +08:00
- 只做当前任务范围内的事;T-504 已接入的多账号并行、dry-run、运行日志属于当前范围,其他 V2 / V3 功能只记录不实现。
- CDP 选择器 / 流程 / 配置 schema 变化,必须同步更新 `docs/04-architecture.md` 与相关任务。
- 改完后更新任务状态、追加 `progress.md`、覆盖 `docs/current-state.md`。
## 安全红线
2026-06-26 16:27:33 +08:00
- 绝不把真实账号、密码、Cookie、token 写进代码、文档或日志;密码/API Key 可在本地配置或 DB 明文保存,但文件必须 gitignore,且不自动登录。
- `config.json`、`config/ai_models.json`、`cmshopee.db`、`chrome_user_data_dir/`、`images/`(含配置、密钥、业务数据、登录态、图片)绝不提交版本库。
2026-06-27 11:29:48 +08:00
- `shopee待处理任务模板.xlsx` 是标准空模板,可提交;运营复制填写后的 Excel 属于业务数据,不提交版本库。
2026-06-26 15:55:28 +08:00
- 「更新」提交线上、删除满 9 张封面等不可逆动作,必须有显式确认;③ 点击「开始更新」后必须弹窗确认,用户确认后才批量更新当前筛选结果。
- 不绕过 Shopee 的验证码、风控、限流或权限校验。
## 验证
```bash
2026-06-26 17:05:18 +08:00
python -m compileall app main.py # 语法检查(T-000 后)
python -m unittest discover -s tests # 纯逻辑单元测试(T-006 完成且 tests/ 存在后)
python prototypes/demo.py # 单账号闭环(不提交)
```
T-006 前若 `tests/` 不存在,不运行 `unittest discover`,只在回复中说明测试基座待建立;T-006 后纯逻辑改动必须跑该命令。
涉及 CDP 改动,在测试商品(ITEM_ID 51100639510)上实跑确认;如命令不可运行,在回复里如实说明。
## 风格
- 文档与 UI 文案用中文,标识符用英文。
- 所有用户可见文本必须使用中文:包括弹窗标题/正文/按钮、窗口标题、按钮、菜单、label、placeholder、tooltip、状态栏、空状态、确认框、运行日志、错误提示和成功提示等。URL、配置键、API 字段、模型别名、第三方/Shopee 原始错误可保留原文,但外围必须给中文解释;不得直接把英文技术报错裸露给用户。
- 内容面向 agent 执行:能落到“读什么、改什么、验证什么”。