wisburg-cli
v0.1.1
Published
Command line client for Wisburg Open API.
Downloads
34
Readme
Wisburg CLI
智堡(Wisburg)Open API 的 Node/TypeScript 命令行封装,覆盖文档中的所有 REST 接口。
English documentation: README_EN.md
安装
npm install
npm run build
npm link鉴权
推荐使用环境变量:
export WISBURG_API_KEY="your-api-key"也可以写入本机配置:
wisburg config set-api-key "your-api-key"默认 Base URL 为 https://api-omen.wisburg.com,可通过 WISBURG_BASE_URL 或 --base-url 覆盖。
示例
wisburg reports list --first 10 --query "宏观"
wisburg reports get 123
wisburg articles list --start-time 2025-01-01 --end-time 2025-02-01
wisburg feed list --first 20
wisburg images list --query "美股"
wisburg request GET /api/reports --query first=5开发时也可以直接运行:
npm run build
node dist/cli.js reports list --first 10已封装接口
官方 API 文档入口:智堡 Open API 文档
| 资源 | 命令 | 接口 | API 文档 |
| --- | --- | --- | --- |
| 研报笔记 | wisburg reports list | GET /api/reports | 文档 |
| 研报笔记 | wisburg reports get <id> | GET /api/reports/:id | 文档 |
| 文献 | wisburg archives list | GET /api/archives | 文档 |
| 文献 | wisburg archives get <id> | GET /api/archives/:id | 文档 |
| 企业研究 | wisburg company-reports list | GET /api/company-reports | 文档 |
| 企业研究 | wisburg company-reports get <id> | GET /api/company-reports/:id | 文档 |
| 电话会纪要 | wisburg earningscalls list | GET /api/earningscalls | 文档 |
| 电话会纪要 | wisburg earningscalls get <id> | GET /api/earningscalls/:id | 文档 |
| 文章 | wisburg articles list | GET /api/articles | 文档 |
| 文章 | wisburg articles get <id> | GET /api/articles/:id | 文档 |
| AI 市场日报 | wisburg market-daily list | GET /api/market-daily | 文档 |
| 资讯流 | wisburg feed list | GET /api/feed | 文档 |
| 图片流 | wisburg images list | GET /api/images | 文档 |
| 资管报告 | wisburg am-reports list | GET /api/am-reports | 文档 |
| 资管报告 | wisburg am-reports get <id> | GET /api/am-reports/:id | 文档 |
所有列表接口都支持:
--first
--after
--query
--start-time
--end-time输出
默认输出格式化 JSON。使用 --raw 可以输出接口原始响应文本。
开发
npm testCI/CD
GitHub Actions 会在 push、pull request 和手动触发时运行:
npm ci
npm test如果仓库 Secrets 中配置了 WISBURG_API_KEY,CI 还会运行真实线上接口测试:
npm run test:integration本地也可以手动跑真实接口测试:
export WISBURG_API_KEY="your-api-key"
npm run test:integration