用途
configure-authentication 用于为 Speakeasy CLI 命令设置身份验证。它适用于以下场景:
- 首次设置 Speakeasy CLI
- 命令返回“unauthorized”错误
- 设置 CI/CD 或 AI 智能体环境
- 用户提到“set up API key”“configure auth”“authentication failed”等
主要能力
该技能的核心能力是完成 Speakeasy CLI 的认证配置,使命令能够访问 Speakeasy 服务。
输入
| 输入 | 是否必需 | 说明 |
|---|---|---|
| API key | 是 | 来自 Speakeasy Dashboard 或浏览器登录 |
输出
| 输出 | 说明 |
|---|---|
| 已认证的 CLI | 命令可以访问 Speakeasy 服务 |
使用方式
交互式登录(推荐)
speakeasy auth login
该命令会打开浏览器进行身份验证。凭据存储在 ~/.speakeasy/config.yaml。
非交互式(CI/AI 智能体)
设置 SPEAKEASY_API_KEY 环境变量:
export SPEAKEASY_API_KEY="<your-api-key>"
获取 API key 的路径:Speakeasy Dashboard → Settings → API Keys。
注意:环境变量的优先级高于配置文件。
验证认证
speakeasy status --output json
如果已认证,返回工作区信息的 JSON;如果未认证,返回 unauthorized 错误。
配置文件位置
凭据存储在 ~/.speakeasy/config.yaml:
speakeasy_api_key: "<your-api-key>"
speakeasy_workspace_id: "<workspace-id>" # optional
# For multiple workspaces:
workspace_api_keys:
org@workspace: "<api-key>"
故障排查
| 错误 | 原因 | 解决方案 |
|---|---|---|
| unauthorized | 缺少或无效的 API key | 运行 speakeasy auth login 或设置 SPEAKEASY_API_KEY |
| workspace not found | 配置了错误的工作区 | 检查 ~/.speakeasy/config.yaml 中的 workspace ID |
| Token expired | 会话超时 | 重新运行 speakeasy auth login |
相关技能
- start-new-sdk-project:快速开始需要认证
- check-workspace-status:验证认证是否正常工作
- regenerate-sdk:生成需要认证
限制
资料中未提供关于该技能的其他限制、收费、价格或平台信息。