安装
安装
- Mac/Linux/Windows WSL
- npm/yarn/pnpm
- Windows PowerShell
💡 推荐:一键安装脚本
只需几秒即可完成安装(相比 npm 安装通常需几分钟),体验更快更便捷:
curl https://static.cloudbase.net/cli/install/install.sh -fsS | bash
npm
npm i -g @cloudbase/cli
yarn
yarn global add @cloudbase/cli
pnpm
pnpm add -g @cloudbase/cli
安装报错:
如果访问官方 npm 源有问题,一般安装过程中报类似 "ETIMEOUT"、"npm ERR! network request to https://registry.npmjs.org/@cloudbase%2fcli failed" 这种错误,这个时候需要临时指定一个国内 npm 镜像源:
npm i -g @cloudbase/cli --registry=http://mirrors.cloud.tencent.com/npm/
yarn global add @cloudbase/cli --registry=http://mirrors.cloud.tencent.com/npm/
irm https://static.cloudbase.net/cli/install/install.ps1 | iex
登录
安装完成后,您需要先登录才能开始使用 CloudBase CLI。CloudBase CLI 提供了多种登录方式,请根据您的使用场景选择合适的方式。
- 云开发控制台授权
- 云 API 密钥授权
- CI 环境登录
- 临时密钥登录
💡 推荐: 适合个人开发者使用:
tcb login
CloudBase CLI 会自动打开云开发控制台获取授权,您需要点击同意授权按钮允许 CloudBase CLI 获取授权。如您没有登录,您需要登录后才能进行此操作。
适合需要更高权限控制的场景:
tcb login --key
回车后,请按提示输入云 API 密钥的 SecretId 和 SecretKey 即可完成登录。
⚠️ 注意:腾讯云 API 密钥可以操作您名下的所有腾讯云资源,请妥善保存和定期更换密钥,当您更换密钥后,请及时删除旧密钥。
首先您需要到云开发平台/云 API 密钥获取密钥。
适合在持续集成环境中使用,避免交互式输入:
tcb login --apiKeyId xxx --apiKey xxx
适合敏感场景,使用短期有效的密钥:
tcb login --apiKeyId xxx --apiKey xxx --token xxx
子账号授权
子账号需要主账号授权资源访问后,才可使用云开发资源。子账号默认没有访问云开发资源的权限,因此使用子账号登录云开发控制台,无法访问云开发资源。
此时,需要为子账号添加预设策略的方式来访问云开发资源。具体操作步骤如下:
- 登录 CAM 控制台,选择左侧菜单【用户】>【用户列表】。
- 进入用户列表页面,单击【新建用户】。
- 进入新建用户页面,根据提示填写用户相关信息。
- 信息填写完毕后,前往策略列表中选择 TCB 预设授权策略。
- 单击【完成】,即可完成创建子账号。
除了上述在创建子账号时添加策略的方式外,也可通过策略关联用户的方式授权,具体请参见 授权管理 指引。
TCB 预设策略
您可以使用以下预设策略为您的子账号授予相关权限:
| 策略 | 描述 |
|---|---|
QcloudAccessForTCBRole | 该策略授予云开发(TCB)对云资源的访问权限。 |
QcloudAccessForTCBRoleInAccessCloudBaseRun | 该策略供云开发(TCB)服务角色(TCB_QcsRole)进行关联,用于 TCB 访问其他云服务资源。包含私有网络 VPC、云服务器 CVM 相关操作权限。 |
该权限包含底层对象存储、云函数、日志、监控、VPC 等资源的全读写权限,一旦为子账号添加此策略,将意味着子账号拥有上述资源,并自动拥有后续新增资源的全读写权限,因此请慎重选择,详情可点击权限名称跳转查看权限规则。
以下预设策略是在您使用 TCB 服务时,授予子账号 CAM 只读访问权限。对子账号进行QcloudCamReadOnlyAccess授权操作后,子账号可使用 CLI 工具网页授权登录;若未进行授权,仅可使用子账号 API 密钥进行登录。您可根据需要对子账号进行开通:
| 策略 | 描述 |
|---|---|
QcloudCamReadOnlyAccess | 该策略授予用户与权限(CAM)只读访问权限。 |
AI 开发
使用 tcb ai 即可开启 AI 开发
tcb ai
所有命令
使用 tcb -h 查看所有可用命令
tcb -h
[可选]使用代理
使用 CloudBase CLI 时,需要您的终端能够访问公网。如果您的终端无法直接访问公网,您可以设置 HTTP 代理使 CLI 能够正常使用。CLI 会读取 http_proxy 或 HTTP_PROXY 环境变量,自动设置网络代理服务。
例如,您可以在终端中运行以下命令,设置 CLI 通过 http://127.0.0.1:8000 的代理服务访问网络:
export HTTP_PROXY=http://127.0.0.1:8000
http://127.0.0.1:8000 只是一个示例,请勿直接使用,具体的代理配置根据你的网络配置决定
上面的命令只是临时设置,当您关闭终端后,代理会自动失效,下次开启终端后需要重新设置。如果您需要一直通过代理访问公网,可以把命令加入到终端的配置文件中。