https://github.com/terryso/polyv-live-cli
Agent-First 设计的保利威直播管理命令行工具
https://github.com/terryso/polyv-live-cli
agent-first bmad bmad-method cli polyv-live-cli skill
Last synced: 2 months ago
JSON representation
Agent-First 设计的保利威直播管理命令行工具
- Host: GitHub
- URL: https://github.com/terryso/polyv-live-cli
- Owner: terryso
- License: mit
- Created: 2025-07-05T10:12:14.000Z (11 months ago)
- Default Branch: develop
- Last Pushed: 2026-03-31T06:58:24.000Z (2 months ago)
- Last Synced: 2026-03-31T08:50:17.004Z (2 months ago)
- Topics: agent-first, bmad, bmad-method, cli, polyv-live-cli, skill
- Language: TypeScript
- Homepage: https://help.polyv.net/#/live/api/
- Size: 5.61 MB
- Stars: 31
- Watchers: 0
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PolyV Live CLI
[](https://nodejs.org/)
[](https://www.npmjs.com/package/polyv-live-cli)
[](https://www.npmjs.com/package/polyv-live-cli)
[](https://codecov.io/gh/terryso/polyv-live-cli)
[](https://github.com/bmad-code-org/BMAD-METHOD)
[](https://zread.ai/terryso/polyv-live-cli)
[](https://github.com/terryso/polyv-live-cli/blob/main/LICENSE)
**Agent-First** 设计的保利威直播管理命令行工具。
## Agent-First 设计理念
PolyV Live CLI 专为 AI Agent 和自动化场景设计：
- **详细帮助文档** - 每个命令都有完整的参数说明和示例
- **结构化输出** - 支持 JSON 格式输出，便于程序化处理
- **清晰错误信息** - 错误消息包含解决建议
- **原生 Skill 支持** - 支持 Claude Code、OpenClaw 等 AI Agent
### 在 AI Agent 中使用
只需告诉 AI 你想做什么，它会自动调用 CLI 完成任务：
```
用户: 帮我创建一个电商直播频道
AI Agent: [自动执行 npx polyv-live-cli@latest channel create ...]
用户: 查看昨天直播的观看数据
AI Agent: [自动执行 npx polyv-live-cli@latest statistics viewdata ...]
用户: 给频道添加一个限时优惠券
AI Agent: [自动执行 npx polyv-live-cli@latest coupon create ...]
```
## AI Agent Skill
本项目提供官方 Skill，让 AI Agent（如 Claude Code、OpenClaw 等）能够智能管理直播服务。
### 功能特点
- **自动认证验证** - 执行命令前自动检查账号状态
- **完整命令参考** - 包含所有命令的详细说明和示例
- **中文文档** - 面向中文用户的完整指南
- **引用文档** - 详细的使用场景和故障排除
### 安装
```bash
npx skills add terryso/polyv-live-cli
```
> 支持 Claude Code、OpenClaw 等所有兼容 Skill 协议的 AI Agent。
### 使用示例
安装后，直接向 AI Agent 提问即可：
```
用户: 我想开始一场电商直播
AI Agent: 我来帮你设置...
1. 创建电商频道
2. 添加商品
3. 创建优惠券
4. 获取推流密钥
用户: 帮我监控直播质量
AI Agent: 正在启动直播监控...
```
## 快速开始
### 安装
```bash
# 推荐：使用 npx 直接运行（始终使用最新版）
npx polyv-live-cli@latest --help
# 或全局安装
npm install -g polyv-live-cli
polyv-live-cli --help
```
### 配置认证
```bash
# 添加账号
npx polyv-live-cli@latest account add myaccount --app-id --app-secret
# 设为默认账号
npx polyv-live-cli@latest account set-default myaccount
```
### 基本使用
```bash
# 创建频道
npx polyv-live-cli@latest channel create -n "新品发布会"
# 获取推流密钥（用于 OBS）
npx polyv-live-cli@latest stream get-key -c
# 开始直播
npx polyv-live-cli@latest stream start -c
# 查看统计数据
npx polyv-live-cli@latest statistics overview -c
```
## 功能模块
| 模块 | 命令 | 说明 |
|------|------|------|
| 频道管理 | `channel` | 创建、查看、更新、删除频道 |
| 推流管理 | `stream` | 获取推流密钥、开始/结束直播、质量监控 |
| 商品管理 | `product` | 添加、查看、更新、删除商品 |
| 优惠券 | `coupon` | 创建、查看、删除优惠券 |
| 回放管理 | `playback` | 查看、删除、合并回放录像 |
| 文档管理 | `document` | 上传、查看、删除直播文档 |
| 统计分析 | `statistics` | 查看观看数据、导出报告 |
| 场景初始化 | `setup` | 一键配置电商、教育等场景 |
## 包结构
```
packages/
├── sdk/ # polyv-live-api-sdk - PolyV Live API SDK
└── cli/ # polyv-live-cli - PolyV Live CLI 工具
```
## 开发
```bash
# 安装依赖
pnpm install
# 构建
pnpm build
# 测试
pnpm test
# 运行 CLI（开发模式）
pnpm --filter polyv-live-cli dev
```
## 发布流程
使用 Changesets 管理版本：
```bash
pnpm changeset # 创建 changeset
pnpm changeset version # 版本升级
pnpm changeset publish # 发布
```
## 相关链接
- [SDK 文档](./packages/sdk/README.md)
- [CLI 详细文档](./packages/cli/README.md)
- [保利威直播 API 文档](https://help.polyv.net/#/live/api/)
- [保利威官网](https://www.polyv.net/)
## 联系方式
- 邮箱: support@polyv.net
- 官网: https://www.polyv.net/
- 技术支持: 400-993-9533
## ⭐ Star History
[](https://www.star-history.com/#terryso/polyv-live-cli&Date)
## Made with ❤️ by PolyV Team
> 让直播管理更简单，让开发者更高效！
## License
MIT