SuperAPI AI 工具集

check-workspace-status

编程与开发

查看项目

更新于 10-19 05:32

技能介绍

用途

check-workspace-status 用于检查当前 Speakeasy 工作区的设置与状态信息。当用户需要确认已配置哪些 SDK 目标、查看已发布 SDK 的版本与 URL、验证工作区认证是否正常时,可以使用该技能。其触发场景包括用户说出“workspace status”“speakeasy status”“what targets configured”“show current…”等表述。

主要能力

该技能的输出包含以下内容:

  • 工作区信息:名称、账户类型。
  • 已发布目标:版本、URL、最后发布或生成日期。
  • 已配置目标:尚未发布的目标及其仓库 URL。
  • 未配置目标:存在问题的目标,以及生成失败情况。

使用方式

该技能通过 speakeasy status 命令执行,提供两种输出格式:

# For LLMs/automation (recommended)
speakeasy status --output json

# For human-readable output
speakeasy status --output console

使用前需要认证,认证方式为通过 speakeasy auth login 或设置 SPEAKEASY_API_KEY 环境变量(参见 configure-authentication 技能)。

输入

输入 是否必需 说明
Authentication 是 通过 speakeasy auth login 或 SPEAKEASY_API_KEY 环境变量提供

输出

输出 说明
Workspace info 名称、账户类型
Published targets 版本、URL、最后发布日期
Configured targets 未发布的目标、仓库 URL
Unconfigured targets 存在问题的目标

适用场景

  • 检查已配置了哪些 SDK 目标。
  • 查看已发布 SDK 的版本和 URL。
  • 验证工作区认证是否正常工作。

限制与故障排查

常见错误及处理方式如下:

错误 原因 解决方案
"unauthorized" API 密钥缺失或无效 运行 speakeasy auth login 或设置 SPEAKEASY_API_KEY
输出为空 未配置任何目标 运行 start-new-sdk-project 设置第一个目标
"workspace not found" 工作区 ID 错误 检查 ~/.speakeasy/config.yaml

相关技能

  • configure-authentication:当状态检查失败时设置 API 密钥。
  • regenerate-sdk:为已配置目标运行生成。
  • start-new-sdk-project:设置新目标。