用途:Stream CLI 用于通过命令行与 Stream 的 API 交互,覆盖 Chat、Video、Feeds、Moderation 等数据查询与操作,也支持安装和配置该 CLI 本身。
主要能力:可列出频道、列出通话、查看被标记消息、查找用户,并查询任意受支持的 API 端点。支持用 --jq 过滤响应,便于处理长输出。
使用方式:先确认 stream 二进制已安装。凭证解析顺序为:当前目录 .env 中的 STREAM_API_KEY;否则查看 stream config list 中已配置的 org/app;都没有则提示运行 stream auth login 或进入含 .env 的项目。端点发现优先读取 ~/.stream/cache/API.md,缺失时运行 stream api --refresh 后重读。首次调用一律使用安全模式:stream --safe api <endpoint> [params]。参数写法为 key=value,布尔值如 is_development=true,JSON 对象或数组用 --body '{"key": "value"}'。若退出码为 5,说明端点会修改数据,需先告知用户再去掉 --safe 重试。
退出码:2 为认证错误,运行 stream auth login 后重试;3 为 API 错误,向用户报告响应信息;4 为规格加载错误,运行 stream api --refresh 后重试;5 为安全模式拒绝。
限制:缺少参数时应询问用户,不得猜测 ID。OrganizationDelete、AppSuspend、AppResume 等操作需联系 Stream 支持。CreateBlockList 与 CreateChannelType 非幂等,已存在会返回 400。Ampere 端点需显式传 app_id/org_id。认证端点属内部接口,应使用 stream auth login / stream auth logout。支持请求可访问 getstream.io/contact。