Betly 命令行
Betly 命令行(betly)装在员工自己的电脑上,用 Betly 员工账号登录后,Claude Code、Codex 等能运行终端命令的 AI 助手就可以代员工查询 Betly 数据。命令行只读,查到的数据不会超出员工本人在后台能看到的范围。
不需要登记应用,也不需要创建 API Key。要开发给多人使用的应用,请看 自建应用接入概览。
前提
- 组织已开通开放 API,否则登录时会被拒绝。
- 登录账号是该组织的在职员工。
- 数据范围取员工本人的后台权限:例如查订单需要【订单管理】,执行数仓 SQL 需要【数仓查询】。
安装
macOS / Linux:
bash
curl -fsSL https://www.mx5.cn/cli/betly/install.sh | shWindows(PowerShell):
powershell
irm https://www.mx5.cn/cli/betly/install.ps1 | iex命令行装到 ~/.betly/bin。macOS / Linux 安装完会提示把这个目录加入 PATH,Windows 会自动加入,重新打开终端后即可运行 betly。
已经装有 Node.js 20 及以上时,也可以用 npm 安装:
bash
npm install -g @betly/cli登录
bash
betly login浏览器会打开 Betly 登录页,用员工账号登录后回到终端即可。电脑没有浏览器(例如远程服务器)时运行 betly login --no-browser:在任意设备上打开终端里显示的地址并登录,再把页面上的授权码粘贴回终端。
登录信息只存在这台电脑上:macOS 存在钥匙串,其他系统存在 ~/.betly/credentials。运行 betly logout 删除。
常用命令
| 命令 | 作用 |
|---|---|
betly whoami | 当前登录的员工与组织 |
betly schema [表名] | 列出数仓里能查的表;带表名时列出字段与说明 |
betly query "<SQL>" [--tables a,b] | 在本组织数仓执行只读 SQL |
betly api GET <路径> [--query 键=值] | 直接调用 /api/v1 下的只读接口 |
betly --help | 查看全部命令,包括按开放接口自动生成的命令 |
betly update | 升级到最新版本 |
终端里输出表格;被 AI 助手或管道读取时输出一行 JSON,加 --json 可强制输出 JSON。
交给 AI 助手
装好并登录后,直接在 AI 助手里用自然语言提问,并说明用 betly 命令,例如:
用 betly 命令查一下本月各门店的订单数,先用 betly schema 看看有哪些表。
AI 助手会自己运行 betly schema、betly query 等命令并整理结果。命令的错误信息写在标准错误输出里,查询结果写在标准输出里,助手可以按退出码判断出了什么问题:
| 退出码 | 含义 | 处理 |
|---|---|---|
| 0 | 成功 | |
| 2 | 参数错误 | 按提示修改命令 |
| 3 | 未登录或登录已失效 | 运行 betly login |
| 4 | 没有权限 | 联系场馆管理员开通对应后台权限 |
| 5 | 查询的内容不存在 | |
| 6 | 查询过于频繁 | 稍后再试 |
| 7、8 | 服务端错误或网络不通 | 稍后再试 |
| 9 | 命令行版本过低 | 运行 betly update |
升级
安装脚本装的运行 betly update 升级到最新版本,betly update --check 只检查不安装;npm 装的运行 npm install -g @betly/cli@latest。命令行每天最多检查一次新版本,有新版时在标准错误输出里提示一行;设置环境变量 BETLY_NO_UPDATE_CHECK=1 可关闭提示。
常见问题
离职或被收回权限后还能查吗? 不能。每次查询都会实时核对在职状态和权限,下一次查询就会被拒绝。
能用命令行修改数据吗? 不能。命令行只读,betly api 也只支持 GET。
