用途:当 OpenAPI 规范已更新、workflow 或 overlay 配置发生变化,或需要用最新 Speakeasy 版本重新生成时,使用 speakeasy run 执行工作流并重建 SDK。
主要能力:执行全部已配置目标或指定目标/源的 SDK 生成,输出更新后的 SDK 代码与生成日志;提供适合 AI 的 console 输出模式,可配合 tail、grep 精简上下文。
必要用法:需在 .speakeasy/workflow.yaml 存在的前提下运行;认证可通过 speakeasy auth login 或设置环境变量 export SPEAKEASY_API_KEY="<your-api-key>"(非交互环境如 CI/CD、AI 智能体应使用后者)。常用命令:speakeasy run(全部目标)、speakeasy run -t <target-name>(指定目标)、speakeasy run -s <source-name>(指定源)、speakeasy run --output console(AI 友好输出)。
适用场景:更新 OpenAPI 规范后、修改 workflow.yaml 后、更改 overlay 后、需要用最新 Speakeasy 版本重新生成时。配置示例中 workflow 含 workflowVersion、speakeasyVersion、sources 与 targets(如 typescript-sdk 指向 typescript 目标、输出到 ./sdk/typescript)。
限制与注意:近期有改动时,不要未检查规范有效性直接运行;不要忽略生成警告,其可能反映 SDK 质量问题;不要在不了解用途时删除 .speakeasy/ 目录。排障可检查 OpenAPI 规范是否有效(speakeasy lint openapi --non-interactive -s <spec>)、workflow.yaml 中 inputs.location 路径是否存在、是否有阻断性校验错误。相关技能包括 start-new-sdk-project、validate-openapi-spec、diagnose-generation-failure、check-workspace-status。