# xhs-summary-cli

**Repository Path**: codecomb/xhs-summary-cli

## Basic Information

- **Project Name**: xhs-summary-cli
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-08
- **Last Updated**: 2026-06-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xhs-summary-cli

从含小红书链接的分享文案中拉取视频，经语音识别后生成中文摘要（基于阿里云 DashScope）。语音识别使用 **千问3-ASR-Flash**（`qwen3-asr-flash`，`MultiModalConversation`），摘要使用 **qwen-max**。

## 环境要求

- **Python**：3.11（本项目 `requires-python` 为 `>=3.11,<3.12`）
- **ffmpeg**：音视频处理（转码、抽取音频等）
- **yt-dlp**：下载视频流

## 安装

```bash
git clone <仓库地址>
cd xhs-summary-cli
python3.11 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -e ".[dev]"
```

## 环境变量

| 变量名 | 是否必填 | 说明 |
|--------|----------|------|
| `DASHSCOPE_API_KEY` | **必填** | 阿里云 DashScope API Key，用于语音识别与摘要调用 |
| `DASHSCOPE_HTTP_API_URL` | 可选 | DashScope HTTP 网关，默认 `https://dashscope.aliyuncs.com/api/v1`（中国内地）；使用新加坡/美国地域时请改为对应文档中的 `api/v1` 根地址 |
| `OUTPUT_DIR` | 可选 | 输出根目录，未设置时默认为当前工作目录（`.`） |
| `XHS_COOKIES_FILE` | 可选 | Netscape 格式的 cookies 文件路径，用于在需要登录态时辅助 yt-dlp 拉取资源 |

使用前请确保已导出 `DASHSCOPE_API_KEY`，例如在 shell 中：

```bash
export DASHSCOPE_API_KEY="你的密钥"
```

## macOS：安装 ffmpeg 与 yt-dlp（Homebrew 示例）

```bash
brew install ffmpeg yt-dlp
```

## 使用示例

将整段分享文案（内含小红书链接）作为参数传入：

```bash
python -m xhs_summary '整段分享文案含链接'
```

也可使用安装后的入口脚本（若已配置 `PATH`）：

```bash
xhs-summary '整段分享文案含链接'
```

## 输出目录结构

在输出根目录（由 `OUTPUT_DIR` 或当前目录决定）下，典型会生成或组织为：

- **video**：下载或处理得到的视频相关文件  
- **audio**：从视频中抽取的音频  
- **text**：语音识别得到的文本  
- **summary**：基于文本生成的摘要  

具体文件名与层级以实际运行结果为准。

## 合规说明与失效风险

- 本工具仅用于你在**合法授权**范围内对自己可访问的内容做离线整理与学习笔记，请遵守小红书及音视频内容的服务条款与版权规定。  
- 平台接口、反爬策略、登录态与 `yt-dlp` 支持的站点规则可能随时变更，导致**下载失败、需 cookies、或流程中断**；这不属于本仓库可保证的长期稳定行为。  
- 语音与摘要依赖第三方云服务（DashScope），存在**配额、计费、模型与 API 变更**带来的差异或不可用风险。  
- **请勿**将 API Key、cookies 等敏感信息提交到版本库或公开渠道。

## 设计文档

更完整的产品与技术设计说明见：

[docs/superpowers/specs/2026-05-14-xhs-summary-cli-design.md](docs/superpowers/specs/2026-05-14-xhs-summary-cli-design.md)