声网 CLI
更新时间不可用
安装 声网 CLI，登录中国区，创建或切换项目，启用能力，并导出本地环境变量。
声网 CLI 是声网提供的命令行工具，可用于登录账号、管理项目、启用能力、导出本地环境变量和检查接入状态。接入中国区对话式 AI 引擎时，你可以用 CLI 完成常见项目配置，减少在控制台和本地环境之间反复切换。
如果你希望 AI Coding Agent 协助接入声网产品，建议先安装 声网 CLI，再配置 声网 Skills 和 声网 MCP。
快速开始
环境要求
- macOS 12 及以上、Linux，或 Windows 10 及以上版本。
- Node.js 18 或更高版本。
安装
使用 npm 安装 声网 CLI：
npm install -g agoraio-cli验证安装
安装完成后，运行以下任一命令确认 CLI 是否可用：
agora --help
agora version如果能正常输出帮助信息或版本号，说明 声网 CLI 已安装成功。
登录并切换到中国区
使用中国区区域参数登录 声网 CLI：
agora login --region cn登录后，可以查看当前身份和登录状态：
agora whoami
agora auth status --json管理项目
查看当前账号下的项目：
agora project list创建一个名为 my-convoai-demo 的项目，并同时启用 rtc 和 convoai 能力：
agora project create my-convoai-demo --feature rtc --feature convoai将当前上下文切换到该项目：
agora project use my-convoai-demo查看当前项目的信息：
agora project show查看 convoai 能力是否已启用：
agora project feature status convoai为当前项目启用 convoai 能力：
agora project feature enable convoai导出本地环境变量
将当前项目凭证按标准模板写入 .env 文件，并覆盖已有内容：
agora project env write .env --overwrite --template standard你也可以指定项目，并将该项目的凭证写入 .env 文件：
agora project env write .env --project prj_xxxxxxxx --overwrite --template standard打开控制台和产品文档
声网 CLI 可以打开当前区域对应的控制台和产品文档。
打开当前区域对应的控制台：
agora open --target console打开当前区域对应的产品文档：
agora open --target product-docs命令会打开以下地址：
console：https://console.shengwang.cnproduct-docs：https://doc.shengwang.cn
本地检查
如果需要检查 声网 CLI 安装状态、网络连通性和登录状态，可以运行：
agora doctor命令参考
| 命令 | 用途 |
|---|---|
agora login --region cn | 登录中国区 |
agora whoami | 查看当前登录身份 |
agora auth status --json | 查看当前登录状态 |
agora project list | 查看当前账号下的项目列表 |
agora project create | 创建项目并按参数启用能力 |
agora project use | 切换当前项目上下文 |
agora project show | 查看当前项目信息 |
agora project feature status | 查询能力状态 |
agora project feature enable | 启用指定能力 |
agora project env write | 将项目凭证写入本地环境变量文件 |
agora open --target console | 打开控制台 |
agora open --target product-docs | 打开产品文档 |
agora doctor | 检查本地环境、网络和登录状态 |