内容
# Releasebot
轻量级命令行和MCP访问 [Releasebot](https://releasebot.io) 目录：从终端或作为任何AI代理的上下文读取发布说明、变更日志和产品公告。
本仓库发布两个软件包：
| 软件包 | 它是什么 | 安装 |
| ------------------------------------ | -------------------------- | ----------------------------- |
| [`@releasebot-io/cli`](packages/cli) | CLI（二进制：`releasebot`） | `npm i -g @releasebot-io/cli` |
| [`@releasebot-io/mcp`](packages/mcp) | AI代理的MCP服务器 | `npx -y @releasebot-io/mcp` |
## 获取API密钥
首先，在 **<https://releasebot.io/sign-up>** 注册Releasebot账户
然后，在 **<https://releasebot.io/notifications>** 生成密钥。密钥类似于 `rb_` 后跟32个字符。免费账户起始积分为500 API积分。
- `search` **免费**（不收取积分）。
- `releases`、`search-releases`、`all` 和 `feed` 每个返回的发布信息需 **1积分** （最低1积分每请求）。
- 响应中包含 `X-Credits-Remaining` 头部；`402` 表示积分用完（在 <https://releasebot.io/billing> 升级）。
| 计划 | 每月积分 |
| ---- | --------------- |
| 免费 | 500 |
| 专业 | 5,000 |
| 最大 | 无限制 |
---
## CLI
```bash
npm install -g @releasebot-io/cli
# 或无需安装直接运行：
npx @releasebot-io/cli search openai
```
### 身份验证
```bash
releasebot auth set rb_your_api_key # 保存到 ~/.releasebot/credentials.json （模式 0600）
releasebot auth status
```
您也可以在环境中设置 `RELEASEBOT_API_KEY` 而不是保存文件。环境变量优先。
### 命令
```bash
# 搜索供应商或产品。返回可以用于返回发布的匹配列表。
releasebot search "github"
# 跨所有发布说明的关键词搜索（任何供应商/产品）
releasebot search-releases "dark mode"
releasebot grep "CVE-2024" --limit 50 # 'grep' 是别名
# 返回供应商的近期发布
releasebot releases openai
# 返回特定产品的近期发布（供应商-_slug/产品-slug）
releasebot releases openai/chatgpt --limit 20
# 返回某个日期或之前发布的版本
releasebot releases apple --before 2025-01-01
# 所有供应商/产品的所有发布，按最新顺序排列
releasebot all --limit 50
# 您关注的订阅源（您在releasebot.io上关注的供应商/产品）
releasebot feed
```
每个数据命令都支持 `--json` 进行原始输出（并在管道传输时发出纯TSV），以及 `-l/--limit <n>`。
```bash
releasebot releases openai --json | jq '.releases[].slug'
```
---
## MCP 服务器
> 您也可以通过我们的托管服务器 <https://releasebot.io/mcp> 访问MCP
将Releasebot添加到任何MCP客户端。适用于Claude Desktop / Cursor的示例（`claude_desktop_config.json` 或 `.cursor/mcp.json`）：
```json
{
"mcpServers": {
"releasebot": {
"command": "npx",
"args": ["-y", "@releasebot-io/mcp"],
"env": { "RELEASEBOT_API_KEY": "rb_your_api_key" }
}
}
}
```
如果您已经运行了 `releasebot auth set`，服务器从 `~/.releasebot/credentials.json` 中获取密钥，您可以省略 `env` 块。
### 工具
- **`search_vendor`** — 按关键词搜索供应商和产品。参数：`query`（必需），`maxResults`，`pageOffset`。
- **`search_releases`** — 列出供应商/产品范围内的近期发布。提供至少一个 `vendorSlug`、`vendorId`、`productSlug`、`productId`。可选：`limit`、`offset`、`before`。
- **`search_release_content`** — 跨所有发布说明（任何供应商/产品）的通用关键词搜索，按最新顺序排列。参数：`query`（必需），`limit`，`offset`，`before`。
---
## 配置
| 变量 | 目的 |
| -------------------- | ------------------------------------------------------------------ |
| `RELEASEBOT_API_KEY` | API密钥（覆盖保存的凭证文件） |
| `RELEASEBOT_API_URL` | 覆盖API基本URL（默认 `https://releasebot.io/api/v1`） |
---
## 开发
这是一个pnpm工作区。
```bash
pnpm install
pnpm build # 构建lib，然后是mcp + cli
pnpm typecheck
```
- `packages/lib` (`@releasebot-io/lib`) 是一个私有、未发布的帮助程序，包含共享的API客户端和类型。在构建时，它被捆绑到CLI和MCP输出中。
- `packages/mcp` 和 `packages/cli` 发布到npm。
## 许可证
MIT
