概述
ModelRiver CLI 是一个用于从实时/生产环境中的 ModelRiver 调试 Webhooks 和 WebSockets 的命令行工具，其使用体验类似于 Stripe CLI。它允许您执行以下操作：
- 通过 WebSocket 监听 Webhooks（无需公网 URL）
- 将 Webhooks 转发到本地 (localhost) 以进行开发
- 测试 WebSocket 连接 并接收实时 AI 响应
- 从命令行触发异步请求
- 在本地验证 Webhook 签名
安装
通过 npm 安装（全局安装）
Bash
npm install -g @modelriver/cli通过 npm 使用（使用 npx）
无需安装：直接运行命令：
Bash
npx @modelriver/cli listen --print从源码安装
Bash
git clone https://github.com/modelriver/modelriver-cli.gitcd modelriver-clinpm installnpm link # 使 `modelriver` 命令在全局可用快速入门
第 1 步：登录（一次性设置）
Bash
modelriver login系统会提示您输入 API 密钥和转发 URL。
第 2 步：开始转发串
Bash
modelriver forward大功告成！Webhooks 将被转发到您配置的 URL。
命令别名
| 命令 | 别名 | 描述 |
|---|---|---|
| listen | l | 监听 Webhooks |
| forward | f | 使用保存的配置进行转发 |
| trigger | t | 发送异步请求 |
| websocket | ws | 测试 WebSocket 连接 |
命令说明
- 监听 (Listen)：无需公网 URL，通过 WebSocket 接收 Webhooks
- 转发 (Forward)：使用保存的配置将 Webhooks 转发到本地 (localhost)
- 触发 (Trigger)：从命令行发送异步 AI 请求
- WebSocket：测试到生产环境的 WebSocket 连接
配置
交互式设置（推荐）
Bash
modelriver login这会将您的配置保存到 ~/.modelriver/config.json。
环境变量
Bash
export MODELRIVER_API_KEY=mr_live_YOUR_API_KEYexport MODELRIVER_API_URL=https://api.modelriver.com # 可选配置文件
JSON
1{2 "api_key": "mr_live_YOUR_API_KEY",3 "api_url": "https://api.modelriver.com",4 "forward_url": "http://localhost:4000/webhook/modelriver"5}优先级：CLI 参数 > 环境变量 > 配置文件 > 默认值
安全性
- API 密钥 本地存储在
~/.modelriver/config.json中 - WebSocket 令牌 是短期有效的（CLI 使用场景下为 24 小时）
- 绝不要 将包含 API 密钥的配置文件提交到版本控制系统中
下一步
- 查看 Webhooks 文档以了解 Webhook 集成
- 探索 客户端 SDK (Client SDK) 以了解前端 WebSocket 连接
- 检查 API 以获取异步请求详情