From a9049a5e477d40cb65a7d51736c8fada116d345d Mon Sep 17 00:00:00 2001 From: home-dev-pookz Date: Wed, 25 Mar 2026 17:32:26 +0800 Subject: [PATCH] update readme --- README.md | 28 +++++++- docs/agent-bootstrap.md | 148 ++++++++++++++++++++++++++++++++++++++++ docs/install.md | 4 ++ 3 files changed, 178 insertions(+), 2 deletions(-) create mode 100644 docs/agent-bootstrap.md diff --git a/README.md b/README.md index b0120ce..0ec4635 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ - [💡 功能特性](#💡功能特性) - [💾 安装指南](#💾安装指南) +- [🤖 AI Agent](#🤖ai-agent) - [🏁 快速开始](#🏁快速开始) - [🗂️ 重构计划](#🗂️重构计划) - [📣 近况说明](#📣近况说明) @@ -39,14 +40,38 @@ ## 💾安装指南 +### 自己上手使用 +如果你只是普通用户,不准备借助 agent 客户端,直接看 + 安装、更新、环境准备已经统一收敛到文档: - [安装说明](./docs/install.md) - [更新说明](./docs/update.md) -补充说明: + +### AGENT + +``` +AI的发展毋庸置疑,希望你遇到这种安装和使用,不要再怯场,而是交给各种AI Agent来协助你 +``` + +如果你准备把这个仓库直接交给 `OpenClaw`、`Codex`、`Claude Code` 来安装和使用 + +先把仓库给 agent,再把这份启动提示词一起发给它: + +- [Agent Bootstrap Prompt](./docs/agent-bootstrap.md) + +这份提示词会引导 agent: + +- 优先按当前主线安装项目 +- 优先使用 `uv`、`sau` CLI 和 `skills/` +- 先验证 `bilibili`、`douyin`、`kuaishou`、`xiaohongshu` 四个平台入口是否可用 + + +### 补充说明: - CLI 使用请看:[CLI 使用说明](./docs/CLI.md) +- 如果你准备在 `OpenClaw`、`Codex`、`Claude Code / cc` 里使用本项目,先看:[Agent Bootstrap Prompt](./docs/agent-bootstrap.md) - agent / skill 请看:[Douyin Upload Skill](./skills/douyin-upload/SKILL.md) - agent / skill 请看:[Kuaishou Upload Skill](./skills/kuaishou-upload/SKILL.md) - agent / skill 请看:[Xiaohongshu Upload Skill](./skills/xiaohongshu-upload/SKILL.md) @@ -56,7 +81,6 @@ - `requirements.txt` 目前主要用于历史兼容路径,普通用户不需要优先使用它 - ## 📣近况说明 `2026.03.24` diff --git a/docs/agent-bootstrap.md b/docs/agent-bootstrap.md new file mode 100644 index 0000000..b1d33db --- /dev/null +++ b/docs/agent-bootstrap.md @@ -0,0 +1,148 @@ +# Agent Bootstrap Prompt + +这份文档是写给 `OpenClaw`、`Codex`、`Claude Code / cc` 这类 agent 客户端用户的。 + +目标不是让 agent 先通读整个仓库,而是先把 `social-auto-upload` 安装到可运行、可验证、可继续执行任务的状态。 + +当前主线已接入的平台: + +- `bilibili` +- `douyin` +- `kuaishou` +- `xiaohongshu` + +## 这份文档解决什么问题 + +现在仓库里已经有: + +- 安装说明 +- CLI 文档 +- 平台 skill + +但这些内容更偏向“agent 进入仓库之后怎么执行”。 + +这份文档补的是“用户第一次把仓库交给 agent 客户端时,应该怎么说”。 + +## 推荐使用方式 + +1. 把整个仓库给你的 agent 客户端。 +2. 把下面这段启动提示词完整发给它。 +3. 等 agent 完成安装和 CLI 验证后,再继续给它下达登录、上传、定时发布等任务。 + +## 通用启动提示词 + +复制下面整段,发给你的 agent: + +```text +你现在在一个名为 `social-auto-upload` 的仓库中工作。 + +这是一个多平台社交媒体自动发布项目。当前主线已经接入: + +- bilibili +- douyin +- kuaishou +- xiaohongshu + +你的第一目标不是通读全部源码,也不是优先运行历史 examples,而是先把项目安装到“可运行、可验证、可继续执行任务”的状态。 + +请遵守以下规则: + +1. 默认把仓库根目录视为当前工作目录。 +2. 优先使用 `uv` 管理 Python 环境,不要默认回退到旧的 `requirements.txt`。 +3. 优先使用当前主线 CLI:`sau`。 +4. 优先参考这些文档: + - `docs/install.md` + - `docs/CLI.md` + - `docs/update.md` +5. 如果需要平台级操作,优先参考这些 skill: + - `skills/douyin-upload/` + - `skills/kuaishou-upload/` + - `skills/xiaohongshu-upload/` + - `skills/bilibili-upload/` +6. 不要默认走历史 `examples/` 和旧 Web 路径,除非当前 CLI 主线不可用。 +7. 如果登录流程生成二维码图片,不要只返回图片路径;请直接展示图片,或者明确告诉我该打开哪个本地图片文件扫码。 +8. 如果是 Bilibili 登录,不要在非交互环境里强行代跑;应改为指导我在本地真实终端执行。 +9. 安装完成后,请优先验证以下命令: + - `sau --help` + - `sau douyin --help` + - `sau kuaishou --help` + - `sau xiaohongshu --help` + - `sau bilibili --help` +10. 完成后,请明确输出: + - 你实际执行了哪些命令 + - 哪些验证通过了 + - 当前项目是否已经进入“可继续登录/上传”的状态 + - 推荐我下一步执行什么 + +如果过程中遇到错误,不要跳过,请先说明错误,再给出你准备采取的下一步动作。 +``` + +## 安装完成后,你可以继续怎么说 + +下面这些是你可以继续发给 agent 的任务示例。 + +### 做一次平台登录 + +```text +请继续帮我登录小红书账号,使用有头模式,账号名用 `creator`。 +``` + +```text +请继续帮我登录抖音账号,使用无头模式,账号名用 `creator`。 +``` + +### 做一次 CLI 可用性检查 + +```text +请检查 bilibili、douyin、kuaishou、xiaohongshu 四个平台的 CLI 入口是否都可用,并告诉我缺什么依赖。 +``` + +### 做一次真实上传 + +```text +请使用 xiaohongshu CLI,帮我上传一个图文草稿,使用定时发布,不要立即发布。 +``` + +```text +请使用 douyin CLI,帮我上传一个视频,优先走当前主线,不要走历史 example。 +``` + +## OpenClaw / Codex / Claude Code 使用建议 + +### OpenClaw + +- 适合直接粘贴上面的完整启动提示词 +- 如果支持把仓库作为工作目录挂载进去,优先先挂载仓库,再发提示词 +- 如果支持本地文件展示,登录二维码应让 agent 直接展示图片 + +### Codex + +- 建议先让它完成 bootstrap,再继续发平台任务 +- 让它优先使用 `docs/install.md`、`docs/CLI.md` 和 `skills/` +- 不要让它一开始自由探索整个仓库,否则容易走到历史路径 + +### Claude Code / cc + +- 建议先让仓库成为当前 workspace +- 再发完整启动提示词 +- 后续按“安装 -> 验证 -> 登录 -> 上传”顺序继续给任务 + +## 为什么不按平台拆四套提示词 + +因为这个项目现在已经有统一的 CLI 主线。 + +用户第一次把仓库交给 agent 时,更需要的是: + +- agent 知道主入口是什么 +- agent 知道应该优先走哪条路径 +- agent 知道哪些是历史路径 +- agent 安装完成后先给出明确验收结果 + +等进入执行阶段,再让 agent 根据你的实际目标去选择: + +- `bilibili` +- `douyin` +- `kuaishou` +- `xiaohongshu` + +这样比给用户准备四套平台 prompt 更稳,也更容易维护。 diff --git a/docs/install.md b/docs/install.md index aa3730a..63b80d5 100644 --- a/docs/install.md +++ b/docs/install.md @@ -5,6 +5,10 @@ - `For Humans`:给正常使用仓库的开发者、创作者、CLI 用户看 - `For AI Agents`:给 OpenClaw、Codex、Claude Code 一类 agent 看 +如果你是“正在使用 agent 客户端的人”,想先给 agent 一段启动提示词,而不是直接阅读下面的执行细节,先看: + +- [Agent Bootstrap Prompt](./agent-bootstrap.md) + ## For Humans ### 1. 克隆项目