rssume 0.3.7 - Docs.rs

<div align="center">

# rssume

[![License](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge&logo=open-source-initiative&logoColor=white)](LICENSE)
[![Rust](https://img.shields.io/badge/Rust-2024_edition-%23dea584?style=for-the-badge&logo=rust&logoColor=white)](https://www.rust-lang.org)
[![CI](https://img.shields.io/badge/CI-passing-brightgreen?style=for-the-badge&logo=githubactions&logoColor=white)](https://github.com/zyxisme/rssume/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/rssume.svg?style=for-the-badge&logo=rust&logoColor=white)](https://crates.io/crates/rssume)

**AI 驱动的 RSS 翻译与摘要中间件。**

订阅源 → 语言检测 → LLM 流式翻译 → AI 摘要 → 增强 RSS

</div>

## 功能

- **多源订阅** — 支持多个 RSS 源，可独立配置轮询间隔和文章数量上限
- **AI 翻译** — LLM 流式翻译，将文章标题和正文转为目标语言（兼容 OpenAI API）
- **AI 摘要** — 每篇文章自动生成一句话 TL;DR，前置插入正文
- **智能重试** — 可配置重试次数和延迟，每次重试自动清理失败状态并创建新日志
- **并发处理** — 可配置最大并发请求数，高效处理多篇文章
- **RSS 增强导出** — content:encoded、dc:creator、category、enclosure 等扩展字段，兼容所有主流 RSS 阅读器
- **OPML 导出** — 一键导出所有订阅源为 OPML 格式，方便迁移到其他阅读器
- **RSS 可读页面** — 浏览器直接访问 RSS 地址即可阅读，XSLT 样式表渲染为美观的 HTML 页面，代码块支持语法高亮、行号、语言标识和一键复制
- **Web 控制台** — 订阅源管理、文章浏览、统计数据、服务控制
- **实时翻译监控** — `/panel/monitor` 实时展示翻译进度、LLM token 流输出、历史日志
- **Token 用量统计** — 按模型和订阅源统计 token 消耗，持久化保存
- **单二进制** — 零运行时依赖，跨平台（Linux / macOS / Windows）

## 快速开始

```bash
# 安装
cargo install rssume

# 首次运行自动生成默认配置
rssume
```

浏览器打开 `http://localhost:3000/panel`，在控制台中配置订阅源和 LLM 即可。

RSS 订阅地址：`http://localhost:3000/feeds/:name`

## 配置

首次运行自动创建 `~/.config/rssume/config.toml`：

```toml
[server]
host = "127.0.0.1"
port = 3000

[language]
target = "zh_CN"  # POSIX locale，直接传给 LLM

[llm]
max_concurrent_requests = 3  # 最大并发翻译请求数
max_retries = 2              # LLM 调用失败最大重试次数
retry_delay_secs = 1         # 重试间隔（秒）

[llm.translation]
provider = "openai"
model = "gpt-4o-mini"
api_key = "${OPENAI_API_KEY}"
base_url = "https://api.openai.com/v1"

[llm.summary]
provider = "openai"
model = "gpt-4o-mini"
api_key = "${OPENAI_API_KEY}"
base_url = "https://api.openai.com/v1"

[[feeds]]
name = "hacker-news"
url = "https://hnrss.org/frontpage"
enabled = true
interval_secs = 300
max_articles = 25  # 每次拉取最大文章数
```

### 配置说明

- **API Key** — 使用 `${ENV_VAR}` 语法引用环境变量，避免明文写入
- **target** — POSIX locale 格式（如 `zh_CN`、`en_US`），直接传给 LLM 作为翻译目标语言
- **max_concurrent_requests** — 控制同时进行的翻译数量，避免 API 限流（默认 3）
- **max_retries** — LLM 调用或解析失败时的重试次数（默认 2）
- **retry_delay_secs** — 每次重试前的等待时间（默认 1 秒）
- **max_articles** — 每次拉取 RSS 时处理的最大文章数（默认 25）

## 面板路由

| 路由 | 说明 |
|------|------|
| `/panel` | Dashboard — 订阅源概览、文章统计、token 消耗 |
| `/panel/monitor` | 全局监控 — 当前翻译进度、最近日志 |
| `/panel/feed/:name` | 订阅源详情 — 文章列表、翻译状态 |
| `/panel/feed/:name/monitor` | 订阅源监控 — 该源的实时翻译进度 |
| `/panel/feed/:name/logs` | 翻译日志 — 历史记录、模型、token 用量 |
| `/panel/settings` | 配置概览 — 当前配置、OPML 导出 |

## API 端点

| 端点 | 说明 |
|------|------|
| `GET /feeds/:name` | RSS 订阅地址（浏览器访问显示可读页面） |
| `GET /feeds/style.xsl` | XSLT 样式表 |
| `GET /api/stats` | 统计数据（JSON） |
| `GET /api/feeds` | 订阅源列表（JSON） |
| `GET /api/feeds/export.opml` | OPML 导出 |
| `GET /api/monitor/status` | 监控状态（JSON） |
| `GET /api/monitor/translating` | 当前翻译任务（JSON） |
| `GET /api/monitor/logs/:name` | 订阅源日志（JSON） |
| `GET /api/token-usage` | Token 用量统计（JSON） |

## 从源码构建

```bash
git clone https://github.com/zyxisme/rssume
cd rssume
cargo build --release
```

## 开发

```bash
# 格式化检查
cargo fmt --check

# 静态分析
cargo clippy --all-targets

# 运行测试
cargo test
```

## 开源协议

MIT