Skip to content

install.md

Latest commit

 

History

History
231 lines (166 loc) · 6.61 KB

install.md

File metadata and controls

231 lines (166 loc) · 6.61 KB

安装说明

这个文档分成两部分：

  • For Humans：给正常使用仓库的开发者、创作者、CLI 用户看
  • For AI Agents：给 OpenClaw、Codex、Claude Code 一类 agent 看

如果你是“正在使用 agent 客户端的人”，想先给 agent 一段启动提示词，而不是直接阅读下面的执行细节，先看：

For Humans

1. 克隆项目

git clone https://github.com/dreammis/social-auto-upload.git
cd social-auto-upload

2. 创建虚拟环境

推荐使用 uv：

Windows PowerShell：

uv venv
.venv\Scripts\activate

Linux / macOS：

uv venv
source .venv/bin/activate

3. 安装主线依赖

当前主线依赖已经放到 pyproject.toml，推荐直接执行：

uv pip install -e .

安装完成后，会注册 sau 命令。

4. 安装 patchright Chromium

当前主线使用 patchright 驱动浏览器。

国内用户推荐先指定镜像，再安装 Chromium。

Windows PowerShell：

$env:PLAYWRIGHT_DOWNLOAD_HOST="https://npmmirror.com/mirrors/playwright"; patchright install chromium

Linux / macOS：

PLAYWRIGHT_DOWNLOAD_HOST="https://npmmirror.com/mirrors/playwright" patchright install chromium

5. 配置 conf.py

复制一份配置：

cp conf.example.py conf.py

Windows 也可以直接手动复制并重命名。

当前通常还会用到这些配置项：

  • LOCAL_CHROME_PATH
  • LOCAL_CHROME_HEADLESS
  • DEBUG_MODE

XHS_SERVER 目前只和小红书旧流程相关。

6. 验证 CLI 是否可用

sau --help
sau douyin --help
sau kuaishou --help
sau xiaohongshu --help
sau bilibili --help

如果命令找不到，优先确认：

  • 当前虚拟环境是否已激活
  • 是否执行过 uv pip install -e .

7. 抖音主线示例

sau douyin login --account <account_name>
sau douyin check --account <account_name>
sau douyin upload-video --account <account_name> --file videos/demo.mp4 --title "示例标题" --desc "示例简介"
sau douyin upload-note --account <account_name> --images videos/1.png videos/2.png --title "图文标题" --note "图文正文"

8. 快手主线示例

sau kuaishou login --account <account_name>
sau kuaishou check --account <account_name>
sau kuaishou upload-video --account <account_name> --file videos/demo.mp4 --title "示例标题" --desc "示例简介"
sau kuaishou upload-note --account <account_name> --images videos/1.png videos/2.png videos/3.png --title "图文标题" --note "图文正文"

9. 小红书主线示例

sau xiaohongshu login --account <account_name>
sau xiaohongshu check --account <account_name>
sau xiaohongshu upload-video --account <account_name> --file videos/demo.mp4 --title "示例标题" --desc "示例简介"
sau xiaohongshu upload-note --account <account_name> --images videos/1.png videos/2.png videos/3.png --title "图文标题" --note "图文正文"

10. Bilibili 主线示例

sau bilibili login --account <account_name>
sau bilibili check --account <account_name>
sau bilibili upload-video --account <account_name> --file videos/demo.mp4 --title "示例标题" --desc "示例简介" --tid 249

补充说明：

  • creator 之类的名字只是示例值，真正传的是用户自定义的 account_name
  • 一个 account_name 对应一个账号文件，可以准备多个账号并发使用
  • 浏览器平台统一元数据约定：
  • 视频使用 title + desc + tags
  • 图文使用 title + note + tags
  • 用户不需要手动安装 biliup
  • 首次运行 Bilibili 相关命令时，程序会自动下载 biliup
  • 后续运行会自动检查上游 release 并自动更新
  • Bilibili 登录建议由用户自己在本地真实终端里执行；如果终端里的二维码显示不完整，可直接打开当前目录下的 qrcode.png 扫码
  • 如果国内网络访问 GitHub Release 较慢，可先用 https://gh-proxy.com/ 或 https://gh-proxy.org/ 辅助访问对应 release 地址排障
  • 示例：
    • https://gh-proxy.org/https://github.com/biliup/biliup/releases/download/v1.1.29/biliupR-v1.1.29-aarch64-linux.tar.xz

For AI Agents

如果你是一个可执行命令的 agent，请优先按下面顺序处理：

  1. 先假设仓库根目录就是当前工作目录
  2. 优先使用 uv 管理环境，不要默认回退到旧的 requirements.txt
  3. 安装命令优先使用：
uv pip install -e .
  1. 如需浏览器驱动，优先使用：

Windows PowerShell：

$env:PLAYWRIGHT_DOWNLOAD_HOST="https://npmmirror.com/mirrors/playwright"; patchright install chromium

Linux / macOS：

PLAYWRIGHT_DOWNLOAD_HOST="https://npmmirror.com/mirrors/playwright" patchright install chromium
  1. 安装完成后，优先检查：
sau --help
sau douyin --help
sau kuaishou --help
sau xiaohongshu --help
sau bilibili --help
  1. 如果用户的目标是抖音或快手的登录、cookie 校验、视频上传、图文上传，优先走 CLI：
sau douyin login
sau douyin check
sau douyin upload-video
sau douyin upload-note

sau kuaishou login
sau kuaishou check
sau kuaishou upload-video
sau kuaishou upload-note

sau xiaohongshu login
sau xiaohongshu check
sau xiaohongshu upload-video
sau xiaohongshu upload-note

sau bilibili login
sau bilibili check
sau bilibili upload-video
  1. 如果用户明确在使用 skill 系统，再引导其阅读：
  • skills/douyin-upload/SKILL.md
  • skills/douyin-upload/references/cli-contract.md
  • skills/kuaishou-upload/SKILL.md
  • skills/kuaishou-upload/references/cli-contract.md
  • skills/xiaohongshu-upload/SKILL.md
  • skills/xiaohongshu-upload/references/cli-contract.md
  • skills/bilibili-upload/SKILL.md
  • skills/bilibili-upload/references/cli-contract.md

对 agent 的额外说明

  • 当登录流程生成本地二维码图片时，不要只把图片路径发给用户
  • 这类二维码图片本身就是给用户扫码的，agent 应优先直接展示/发送本地图片给用户扫码
  • 如果环境支持查看本地图片，优先用查看图片能力把二维码展示出来；路径只作为补充信息
  • Bilibili 登录当前不建议 agent 在非交互环境里直接代跑
  • 正确做法是让用户自己在本地终端执行 sau bilibili login --account <name>；如果二维码显示不完整，再提示用户打开 qrcode.png
  • requirements.txt 目前是历史兼容文件，不是主安装入口
  • uploader/ 是核心实现目录
  • sau_cli.py 是当前 CLI 主入口
  • docs/legacy-web.md 是历史 Web 版本说明，不保证当前可用
  • Bilibili 首次运行时可能自动下载 biliup