Track bundled vendor runtime sources
Some checks failed
CI / main (push) Has been cancelled
CI / release-e2e (push) Has been cancelled

This commit is contained in:
2026-07-07 10:05:50 +08:00
parent fbe179ab53
commit 52636c91ae
2111 changed files with 1850012 additions and 14 deletions

View File

@@ -0,0 +1,103 @@
# 小红书 CLI 契约
这个 skill 默认假设当前环境已经安装并可调用 `sau` 命令。
## 命令列表
### 登录
```bash
sau xiaohongshu login --account <account>
```
- 必填参数:
- `--account`
- 作用:
- 启动小红书登录流程,为指定账号生成或刷新 cookie 文件
- 如果登录过程中生成本地二维码图片agent 应优先直接把图片展示/发送给用户扫码,而不是只回传路径
- 账号说明:
- `--account` 传的是用户自定义的 `account_name`,不是固定只能叫 `creator`
- 一个 `account_name` 对应一个账号文件,可用于多账号隔离和并发任务
### 校验 cookie
```bash
sau xiaohongshu check --account <account>
```
- 必填参数:
- `--account`
- 预期输出:
- `valid`cookie 可用
- `invalid`cookie 缺失或已失效
### 上传视频
```bash
sau xiaohongshu upload-video \
--account <account> \
--file <video-path> \
--title "<title>" \
[--desc "<description>"] \
[--tags tag1,tag2] \
[--schedule "YYYY-MM-DD HH:MM"] \
[--thumbnail <image-path>] \
[--debug] \
[--headless | --headed]
```
- 必填参数:
- `--account`
- `--file`
- `--title`
- 可选参数:
- `--desc`
- `--tags`
- `--schedule`
- `--thumbnail`
- `--debug`
- `--headless`
- `--headed`
### 上传图文
```bash
sau xiaohongshu upload-note \
--account <account> \
--images <image-1> [image-2 ...] \
--title "<title>" \
[--note "<content>"] \
[--tags tag1,tag2] \
[--schedule "YYYY-MM-DD HH:MM"] \
[--debug] \
[--headless | --headed]
```
- 必填参数:
- `--account`
- `--images`
- `--title`
- 可选参数:
- `--note`
- `--tags`
- `--schedule`
- `--debug`
- `--headless`
- `--headed`
## 发布策略
- 如果不传 `--schedule`CLI 使用立即发布
- 如果传了 `--schedule`CLI 自动切换为定时发布
- 时间格式为:
```text
YYYY-MM-DD HH:MM
```
## 额外说明
- `upload-video` 每次命令只支持一个视频文件
- `upload-note` 每次命令支持多张图片
- 视频描述字段统一使用 `--desc`
- 图文正文统一使用 `--note`

View File

@@ -0,0 +1,67 @@
# 运行前提
这个 skill 默认假设当前环境已经具备:
- 已安装 `social-auto-upload`
- 可以调用 `sau` 命令,或至少有等效调用方式
- 已为 `patchright` 安装 Chromium
## 推荐安装方式
在项目根目录执行:
```bash
uv pip install -e .
```
## 安装 patchright 浏览器
Windows PowerShell
```powershell
$env:PLAYWRIGHT_DOWNLOAD_HOST="https://npmmirror.com/mirrors/playwright"; patchright install chromium
```
Linux / macOSbash / zsh
```bash
PLAYWRIGHT_DOWNLOAD_HOST="https://npmmirror.com/mirrors/playwright" patchright install chromium
```
## 常见调用方式
### 如果 `sau` 已经在 PATH 中
```bash
sau xiaohongshu --help
```
### 如果虚拟环境存在,但还没有激活
PowerShell
```powershell
.\.venv\Scripts\Activate.ps1
sau xiaohongshu --help
```
### 如果你想直接调用可执行文件
PowerShell
```powershell
.\.venv\Scripts\sau.exe xiaohongshu --help
```
### 如果你更倾向于使用 uv
```bash
uv run sau xiaohongshu --help
```
## 无头和有头模式
- 使用 `--headless` 表示无头模式
- 使用 `--headed` 表示有头模式
- 如果用户明确要求无头登录,也要预期 CLI 会通过控制台输出或临时图片路径提供二维码相关提示
- 如果登录过程中已经生成了本地二维码图片agent 应优先直接把图片展示/发送给用户扫码,不要只告诉用户图片路径

View File

@@ -0,0 +1,78 @@
# 故障排查
## 找不到 `sau` 命令
可以尝试以下方式:
```powershell
.\.venv\Scripts\Activate.ps1
sau xiaohongshu --help
```
```powershell
.\.venv\Scripts\sau.exe xiaohongshu --help
```
```bash
uv run sau xiaohongshu --help
```
如果当前环境还没有安装项目:
```bash
uv pip install -e .
```
## cookie 无效或已过期
先检查 cookie 状态:
```bash
sau xiaohongshu check --account <account>
```
如果无效,就重新登录:
```bash
sau xiaohongshu login --account <account>
```
## 无头登录二维码处理
如果用户无法使用终端二维码输出:
- 查找 CLI 打印出来的临时二维码图片
- agent 不要只把图片路径回给用户
- agent 应优先直接把本地二维码图片展示/发送给用户扫码
如果终端二维码显示不正常,优先使用保存下来的图片路径,而不是反复尝试随机的终端设置。
## 上传参数缺失
### 视频上传
最少需要:
- `--account`
- `--file`
- `--title`
### 图文上传
最少需要:
- `--account`
- `--images`
- `--title`
`--note` 当前是可选图文正文。
## 定时发布
时间格式使用:
```text
YYYY-MM-DD HH:MM
```
如果不需要定时发布,去掉 `--schedule` 即可改为立即发布。