Skip to main content
platform-cli 是开放平台的命令行工具,可在终端中完成登录、空间切换、API Key 管理、用量查询与组织管理,适用于脚本化和批量操作的场景。控制台中常用的成员、项目、额度与用量管理均有对应命令。

安装

运行环境要求 Node.js 20.0.0 及以上版本。
安装完成后通过以下方式调用:
任意命令追加 -h 可查看该命令的帮助文本,其中标注了命令的适用空间。

登录

登录后始终进入个人空间。在非交互式环境中请显式指定登录方式,例如 platform-cli auth login browser,或 platform-cli auth login sms --mobile <手机号> --code <验证码> 短信验证码登录需要后端签名凭证。CLI 按以下优先级加载:先读取环境变量 PLATFORM_API_USERPLATFORM_API_SECRET,未设置时再读取 ~/.platform-cli/config.json 中的 apiUserapiSecret 字段。

空间

命令行的所有操作都在一个空间中进行,会话始终处于个人空间或某个组织空间。命令按适用空间划分,在不适用的空间下执行会失败并提示先切换空间。空间与组织的概念见组织与项目

个人空间命令

API Key

管理个人账号的 API Key。个人空间下有且仅有一个默认 API Key,该 Key 不能更新或删除,create 用于创建额外的非默认 API Key。

用量与速率限制

查询 Step Plan 的用量记录与速率限制状态。

代金券

组织空间命令

以下命令需先切换到组织空间。org memberorg project 系列命令仅主账号可用;org key 操作的是您本人在各项目下的 API Key,任意组织成员均可使用。

成员管理

项目管理

项目成员

项目额度

limit<amount> 单位为 Credit,取值 0 表示清除该项目的额度限制。额度规则见 Credit 额度规则

项目下的 API Key

主账号通过以下命令管理项目下的全部 API Key,包括自己在该项目下创建的 API Key。limit<amount> 取值 0 表示清除该 Key 所属成员在本项目内的额度限制。

组织额度与用量

本人在各项目下的 API Key

语言设置