SuperAPI AI 工具集

nx-cloud-api

部署与运维

查看项目

更新于 10-16 02:33

技能介绍

用途:通过 npx nx-cloud api 以只读方式查询 Nx Cloud 公共 API,回答明确的工作区数据问题,例如检查或检索 CIPEs、流水线、运行和任务记录。它是 API 访问技能,不是报告生成器或配置编辑器。所有命令需在工作区根目录运行,以便找到 nx.json。

主要能力:支持发现端点(--list-operations)、查看操作详情(--describe)、列出操作(--print-api-spec),以及执行查询。输出为 JSON,stdout 仅含响应数据,stderr 每行一个 JSON 对象(error、output,加 -i 或 NX_VERBOSE_LOGGING 时还有 response、log)。资产下载的原始字节写入 -o 文件。

使用方式:先运行 npx nx-cloud api --help 或 npx nx-cloud api 查看语法和选项。用 --list-operations 查找路由,用 --describe <operationId | path | link> 查看参数、响应字段和错误状态。从 cipes 开始,跟随返回的 links 值,不要手工构建子 URL。按 ID 寻址实体时,使用 --describe 中的 {placeholder} 路径,并用 -p name=value 填充,切勿将 ID 直接粘贴到路径中。默认获取一页,用 -f 添加过滤条件,用 -o 将响应写入临时目录文件,再用 jq 投影所需字段。

适用场景:需要检查或检索 Nx Cloud 工作区数据,如 CIPEs、流水线、运行和任务记录。

限制:不用于轮询或监控实时 CI。API 返回的是已记录的任务和运行字段,不查询本地 Nx 目标;cacheEnabled 描述已记录的运行,cacheable 描述已记录的任务,均不能识别 targetDefaults、推断目标或工具原生缓存。不要从缺失的项目属性推断 cache: false。缓存原因、目标设置、输入输出或配置变更需使用 nx-cloud-cache-investigator。API 数据本身不足以支撑缓存或输入相关的拉取请求。需检查退出码,错误类型包括 usage、http、network、response、output。401 需运行 npx nx-cloud login --status 检查登录状态。403 表示组织计划不包含 Nx Cloud 公共 API。429 表示组织配额耗尽。5xx 可短暂等待后重试一次。--list-operations、--describe 和 --print-api-spec 不需要凭证。未经用户明确请求,不要更改工作区配置或凭证。