Skip to content

使用 CLI 工具

DevTools CLI 是面向研发、联调、测试验收和现场排查的命令行工具。

当前页先覆盖最常用的两个动作:

  • 安装或更新 CLI
  • 生成开发联调用的连接 Token 和二维码

CLI 适合调试使用。生产环境的 Token 应由你的业务服务端签发。

安装

安装或更新最新版:

bash
npm install -g tirtc-devtools-cli@latest

确认安装结果:

bash
tirtc-devtools-cli --help

能看到帮助菜单,即表示 CLI 可用。

生成连接 Token

生成 Token 前,准备好:

  • AccessKeyId
  • SecretKeyId
  • AppId
  • remote_id

建议先写入环境变量:

bash
export TIRTC_ACCESS_KEY_ID="your_access_key_id"
export TIRTC_SECRET_KEY_ID="your_secret_key_id"
export TIRTC_APP_ID="your_app_id"

生成 Token:

bash
tirtc-devtools-cli token issue your_remote_id

如需指定非默认接入环境,同时传入 endpoint:

bash
tirtc-devtools-cli token issue your_remote_id \
  --endpoint http://ep-test-tirtc.tange365.com \
  --openapi-endpoint http://api-test-tirtc.tange365.com

执行成功后,CLI 会输出:

  • 连接 Token
  • 控制台二维码
  • 本地二维码 PNG 路径

你可以用示例客户端扫码验证连接。

常见失败

Token 生成失败

优先检查:

  • TIRTC_ACCESS_KEY_IDTIRTC_SECRET_KEY_IDTIRTC_APP_ID 是否已配置
  • remote_id 是否正确
  • 非默认环境下,--endpoint--openapi-endpoint 是否同时传入

仍然失败时,先保留完整命令、CLI 输出和二维码 PNG 路径,再进入排查。

TiRTC 开发文档