К основному содержанию
скилл CX Codex

nx-cloud-api — скилл для Claude Code: запросы к Nx Cloud

Скилл nx-cloud-api для Claude Code, который читает данные рабочего пространства через публичный API Nx Cloud. Агент подключает его для просмотра запусков CI, задач, кэша и сведений об API.

MIT 121 установок ★ 29 обновлён 2026-10-23

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add nrwl/nx-ai-agents-config --skill nx-cloud-api -a claude-code
Открыть на GitHub

Что делает nx-cloud-api

Скилл помогает агенту находить эндпоинты и запрашивать данные Nx Cloud командой npx nx-cloud api. Он охватывает переходы по ссылкам из ответов, постраничную загрузку, скачивание файлов и обработку ошибок. Ответы API доступны в режиме чтения: скилл не меняет конфигурацию и не предназначен для наблюдения за текущим CI.

Команду запускают из корня Nx workspace, где находится nx.json, либо передают --nxCloudId <id>. Для авторизации используются токен рабочего пространства, OAuth-вход через npx nx login или сохранённый в nxcloud.ini персональный токен. Скилл предлагает сначала просмотреть доступные операции через npx nx-cloud api --list-operations, а детали маршрута узнать через --describe; идентификаторы передаются параметрами, а не вставляются в путь. Данные API описывают записанные запуски и задачи, но не настройки локальных целей Nx.

Какие задачи решает

  • найти данные о CIPE, пайплайне или запуске
  • получить сведения о задачах и статистике их выполнения
  • просмотреть данные о нестабильных задачах и кэше
  • узнать параметры и ответы эндпоинта Nx Cloud

Примеры запросов агенту

  • Покажи неудачные запуски CI в этом рабочем пространстве.
  • Найди статистику задач и сведения о нестабильных задачах.
  • Опиши эндпоинты Nx Cloud для получения данных о запусках.

Как установить nx-cloud-api

1Через Skills CLI (Vercel)

npx skills add nrwl/nx-ai-agents-config --skill nx-cloud-api -a claude-code

2Вручную: положить файлы

~/.claude/skills/nx-cloud-api/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/nx-cloud-api/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о nx-cloud-api

Как установить nx-cloud-api в Claude Code?

Выполни npx skills add nrwl/nx-ai-agents-config --skill nx-cloud-api -a claude-code. Файл скилла находится по пути ~/.claude/skills/nx-cloud-api/SKILL.md.

Что делает nx-cloud-api?

Он помогает агенту читать данные Nx Cloud через npx nx-cloud api: искать операции, получать сведения о запусках и задачах, переходить по ссылкам из ответов и обрабатывать ошибки. Запросы работают только на чтение; скилл не предназначен для мониторинга текущего CI.

Что нужно для работы nx-cloud-api?

Нужна авторизация Nx Cloud: токен рабочего пространства, OAuth-вход через npx nx login или сохранённый персональный токен. Для OAuth- и персонального токена требуется Nx Cloud ID рабочего пространства; его можно передать через --nxCloudId <id>, если команда запущена вне Nx workspace.

Исходный текст

SKILL.md · MIT
---
name: nx-cloud-api
description: Query the read-only Nx Cloud Public API for workspace data with `npx nx-cloud api`. Use this skill when a user asks to inspect or retrieve CIPEs, pipelines, run groups, runs, tasks, workflows, agents, task statistics, flaky tasks, cache data, or API endpoint details. Use this skill before any Nx Cloud API call. It covers endpoint discovery, link navigation, pagination, asset downloads, and error recovery. Do not use it for live CI monitoring.
---

# Nx Cloud API

Answer a defined workspace-data question with `npx nx-cloud api`, the read-only
Nx Cloud Public API command. This is an API access skill, not a report generator
or configuration editor. Run every command from the workspace root so the
command finds `nx.json`, or pass `--nxCloudId <id>` to name the workspace
(see Authentication).

Run `npx nx-cloud api --help` (or `npx nx-cloud api` alone) once for syntax and
options. This skill covers the workflow around it.

All output is JSON. stdout carries only the response data. stderr carries one
JSON object per line: `{"error": ...}`, `{"output": ...}`, and, with `-i` or
`NX_VERBOSE_LOGGING`, `{"response": ...}` and `{"log": ...}`. The one exception
is an asset download, whose raw bytes go to the `-o` file.

## Non-negotiable rules

- Discover endpoints from the live spec. Use `npx nx-cloud api --list-operations`
  to find a route and `npx nx-cloud api --describe <operationId | path | link>`
  for its parameters, response fields, and error statuses. Both show what an
  operation `returns`: `list` (the wrapped list below), `object` (the response
  body), or `file` (an asset download). Do not use
  remembered routes, fields, filter names, or enum values.
- Start at `cipes` and follow returned `links` values. Do not build child URLs by
  hand or use an internal workflow ID as a route parameter. When you must
  address an entity by ID, use the `{placeholder}` path from `--describe` and
  fill it with `-p name=value`. Never paste an ID into a path: IDs are raw and
  can contain `/` or `:` (task IDs like `@scope/app:build`).
- Start with one filtered page. Ask for a workspace, scope, or time range when
  they are missing. Do not collect history by default.
- Read the operation description from `--describe`. It states server limits that
  the command does not enforce.
- Do not use this skill to poll or monitor live CI.

## Authentication

`npx nx-cloud api` authenticates for you; do not read credentials out of
`nxcloud.ini` or call the API with `curl`. It sends the first available of:

1. A workspace token in `NX_CLOUD_ACCESS_TOKEN` (or `NX_CLOUD_AUTH_TOKEN`). When
   one is set, the command uses it alone and ignores any stored login.
2. The user's OAuth login from `npx nx login`, refreshed as needed.
3. A personal access token stored in `nxcloud.ini` by an older login.

A login or personal access token also needs the workspace's Nx Cloud ID, sent
as `Nx-Cloud-Id`. The command reads it from `nxCloudId` in `nx.json`;
`--nxCloudId <id>` overrides it and works outside an Nx workspace, so you can
query a workspace you are a member of without its checkout. A workspace token
always reads its own workspace and ignores the ID.

If you must call the API without the command, the headers differ per
credential, and an OAuth access token is not a bearer token:

| Credential            | Headers                                                           |
| --------------------- | ----------------------------------------------------------------- |
| Workspace (CI) token  | `Authorization: Bearer <token>`                                   |
| OAuth access token    | `Nx-Cloud-OAuth-Access-Token: <token>` and `Nx-Cloud-Id: <id>`    |
| Personal access token | `Nx-Cloud-Personal-Access-Token: <token>` and `Nx-Cloud-Id: <id>` |

## Cache boundary

The API returns recorded task and run fields. It does not query the local Nx
target. `cacheEnabled` describes the recorded run. `cacheable` describes the
recorded task. Neither value identifies `targetDefaults`, an inferred target,
or Vite, ESLint, or another tool-native cache.

Do not infer `cache: false` from an absent project property. For cache causes,
target settings, inputs, outputs, or a configuration change, use
`nx-cloud-cache-investigator`. API data alone cannot justify a cache or inputs
pull request.

## Quick workflow

```sh
npx nx-cloud api --describe cipes

# Save one bounded page to a scratch file, then project only what you need.
dir="$(mktemp -d)"
npx nx-cloud api cipes \
  -f createdAfter=2026-08-01T00:00:00Z \
  -f statuses=FAILED -f statuses=CANCELED \
  -o "$dir/cipes.json"
echo "exit $?"
jq '{pageLimitReached, nextCursor, items: [.items[] | {id, status, createdAt, links}]}' "$dir/cipes.json"

# Follow a link from a previous response as-is.
npx nx-cloud api "<link from a previous response>" -o "$dir/next.json"

# Address an entity by ID only through a path parameter.
npx nx-cloud api 'runs/{runId}/tasks' -p runId="$run_id" -o "$dir/tasks.json"
```

Pass a `links.*` value exactly as returned; it may already carry query
parameters, and `-f` adds more. Full URLs are accepted only on the configured
Nx Cloud host. That includes app links such as `https://cloud.nx.app/cipes/<id>`,
which resolve like the bare path `cipes/<id>`.

## Keep API output compact

To preserve context, write every live data response to a file with `-o` (files are created
owner-only) in a scratch directory outside the workspace. Give the file an
extension. A name without one gets `.json`, `.ndjson`, or the download's own
(such as `.tar.gz`), and the command reports the final path on stderr as
`{"output": {"file": "..."}}`. Create the scratch directory with `mktemp -d`,
and read a question-specific `jq` projection. Do not let
a raw collection print into the conversation unless the user asks for it.
Choose projected fields from `--describe`. For one row, select it first, then
project only the needed fields. Delete saved data when the task is done unless
the user asks to keep it.

`--describe` output is usually small. Pipe it through `jq` only when you need
part of a large operation.

## Exit codes and errors

Always check the exit code. Every failure prints one record on stderr, and the
command adds no recovery hints; do not hide stderr with `2>/dev/null`:

```text
{"error":{"type":"http","message":"HTTP 409 Conflict","status":409,"url":"...","body":{"code":"not_terminal","message":"..."}}}
```

`type` is `usage`, `http`, `network`, `response` (an answer the command cannot
use), or `output` (an unwritable `-o` file). For `http`, `body` is the server's
error body, parsed when it is JSON and absent when it is empty. Exit 4 and 5
bodies carry a stable `code` (except 401 and an empty-body 429); branch on
`.error.body.code`, not on the prose `message`.

| Exit | HTTP | `code`                                                                                               | Next action                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ---- | ---- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1    | —    | —                                                                                                    | Usage, network, response, or output error; read `.error.type` and `.error.message` on stderr. Fix the flags, path, or `-p` values, or check the host (`NX_CLOUD_API` or `nxCloudUrl`), proxy, and VPN.                                                                                                                                                                                                                                                                                                      |
| 4    | 400  | `invalid_parameter`                                                                                  | Run `npx nx-cloud api --describe <same path>` and fix the named parameter. Unknown query parameters are always rejected.                                                                                                                                                                                                                                                                                                                                                                                    |
| 4    | 400  | `invalid_limit`, `invalid_timestamp`, `invalid_date_range`, `invalid_filter`                         | Fix the value or filter combination named in `message`, using `--describe` for formats and limits.                                                                                                                                                                                                                                                                                                                                                                                                          |
| 4    | 400  | `invalid_cursor`                                                                                     | A cursor is valid only for the list that minted it. Resume with the same path and filters, or restart without `cursor`.                                                                                                                                                                                                                                                                                                                                                                                     |
| 4    | 401  | none (`body` is plain text)                                                                          | When `NX_CLOUD_ACCESS_TOKEN` is set, `nx-cloud api` sends that token alone, so the 401 means the token is invalid or has no access to this workspace; tell the user. Otherwise `nx-cloud api` sends the user's Nx Cloud login for this host with `nxCloudId` from `nx.json`: run `npx nx-cloud login --status` from the workspace root, and when it does not report the user as logged in, ask them to run `npx nx login`, which signs in by approving a code in the browser, and to follow what it prints. |
| 4    | 403  | `plan_not_allowed`                                                                                   | The organization's plan does not include the Nx Cloud Public API. Tell the user; do not retry or use another person's token.                                                                                                                                                                                                                                                                                                                                                                                |
| 4    | 404  | `not_found`                                                                                          | The ID in the path or in a parent-ID filter (`cipeId`, `runGroup`, `stepId`, `agentName`) is wrong. An unknown parent is never an empty result. Recheck the ID, or follow a link instead.                                                                                                                                                                                                                                                                                                                   |
| 4    | 404  | none (no `body`)                                                                                     | The path matched no route, usually because a raw ID containing `/` (such as `@scope/app:build`) was pasted into it. Use the `{placeholder}` path with `-p`, or follow `links`, and check the path with `--describe`.                                                                                                                                                                                                                                                                                        |
| 4    | 409  | `not_terminal`                                                                                       | The entity is still running. This is not a failure; its data is not final yet. See same-session retry below.                                                                                                                                                                                                                                                                                                                                                                                                |
| 4    | 429  | `rate_limit_exceeded` or no `body`                                                                   | The organization-wide quota is exhausted. The command already retried 3 times honoring `Retry-After`. Back off, narrow filters, and make fewer requests.                                                                                                                                                                                                                                                                                                                                                    |
| 5    | 503  | `data_api_at_capacity`, `query_deadline_exceeded`, `audit_log_unavailable`, `rate_limit_unavailable` | No data was returned. The command already retried 3 times. Back off before one more attempt; for `query_deadline_exceeded`, narrow the time range or filters.                                                                                                                                                                                                                                                                                                                                               |
| 5    | 5xx  | other                                                                                                | Retry once after a short wait. Keep the endpoint, filters, time range, and `traceId` from the body for support.                                                                                                                                                                                                                                                                                                                                                                                             |

`--list-operations`, `--describe`, and `--print-api-spec` do not need
credentials, so they succeed even when data requests fail with 401.

Do not alter workspace configuration or credentials without the user's explicit
request.

## Same-session retry

For a 409 `not_terminal` on a known request, arrange at most one same-session
wake after the entity is expected to finish. Preserve the link and filters.
Stop at a terminal response.

## Pagination

Every list response is wrapped, even a single page:
`{source, pagesFetched, fetchedItemCount, pageLimitReached, nextCursor, items}`.
`source` records the origin, endpoint, and original query. Read rows with
`jq '.items[]'`. Non-list responses are returned as-is.

The list is complete only when the exit code is 0 and `nextCursor` is `null`.
`pageLimitReached: true` means `--pages` stopped the run while more results
exist. To continue, rerun the same path and filters with
`--cursor <nextCursor>`, or state that the data is incomplete. The output's
`source.query` records the cursor it started from.

The command fetches one page by default. Raise `--pages` deliberately and keep
it small; prefer narrower filters over more pages. Do not fetch many
`flaky-tasks` or `task-stats` pages without a narrow filter. Leave the page size
alone unless needed: every page costs one unit of the organization's rate
limit, and `--page-size` (which sets `limit`, max 500) only helps when raised.

If a later page fails, the command still prints what it fetched, with
`nextCursor` at the failed page, and exits 4 or 5. Handle the error, then
resume from that cursor.

`--format ndjson` prints only the rows, one per line, with no metadata. Nothing
in its output says whether more pages exist, and it records no resume cursor. It prints each page as it is retrieved which can matter for responsiveness or very large responses.
Use it only when completeness does not matter; otherwise use the default JSON
output.

For multi-range extraction, task or log assets, or a calculation, read
[references/extraction-and-calculation.md](references/extraction-and-calculation.md)
first.

## Interpret responses

Collection responses have top-level `items` and `nextCursor`. Single resources
are returned as-is. Do not infer a field meaning from its name; check
`--describe` and a live record first.

Label cache statements by evidence source:

- **API response field:** a recorded `cacheEnabled`, `cacheable`, cache-status,
  or hash value.
- **Nx target query:** a value from `nx show project ... --json` in a matching
  checkout.
- **Tool-native cache:** `Unknown` until its executor options are inspected.

## Empty task assets

A valid task asset can have zero-byte terminal output and no output files;
`nx:noop` commonly does. Check the matching workspace task before reporting a
log-capture or archive defect.

## Report

State the operations queried, filters, item counts, and whether the data is
complete. State whether a result is recorded API data, a local target query, or
a hypothesis. Never claim that an API-only read proved configuration provenance
or tool-native cache state.

© nrwl · MIT · nrwl/nx-ai-agents-config

Похожие скиллы

Все скиллы по теме «Бэкенд и API» →
huawei-cloud-sac-new-api huaweicloud Скилл huawei-cloud-sac-new-api разворачивает шлюз NewAPI на Huawei Cloud через Terraform. Он пригодится, если нужно управлять запросами к нескольким LLM через один шлюз. CX Codex +1 189установок AWS Cloud Control API awslabs MCP-сервер AWS Cloud Control API управляет ресурсами AWS через Cloud Control API по запросам на обычном языке. Сервер устарел и больше не получает обновлений; для новых задач авторы предлагают перейти на AWS IAC MCP Server. CX Codex +1 ★ 9 939звёзд репо whatsapp-cloud-api Bello Sánchez Скилл подкладывает агенту справку по WhatsApp Cloud API: отправка сообщений, вебхуки, шаблоны, окно 24 часов и коды ошибок. CX Codex +1 711установок cloud-api-integration martinholovsky Скилл cloud-api-integration для Claude Code помогает подключать облачные AI API и защищать интеграцию. Он включается при проектировании клиентов для Claude, GPT-4 и Gemini. CX Codex +1 203установок domain-cloud-native actionbook Скилл domain-cloud-native задаёт правила разработки облачных микросервисов на Rust: от сигналов завершения работы до проверок готовности в Kubernetes. CX Codex +1 3 200установок cloud-functions TencentCloudBase Скилл cloud-functions для Claude Code и Codex. Ведёт агента по созданию, деплою и отладке Event и HTTP Functions в CloudBase. Требует выбрать тип функции заранее — рантайм после создания не меняется. CX Codex +1 1 200установок

Из того же набора9

nx-workspace Скилл nx-workspace для Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode, который даёт агенту команды для навигации по Nx-монорепозиторию. CX Codex +1 100 600установок nx-run-tasks Скилл nx-run-tasks для Claude Code подсказывает агенту, как запускать build, test, lint и serve в монорепозитории Nx. Проектов много, и команды легко перепутать. CX Codex +1 4 100установок nx-generate Скилл nx-generate для работы с генераторами Nx: подсказывает агенту, как создать библиотеку или приложение в монорепозитории и не сломать существующие шаблоны. CX Codex +1 4 000установок link-workspace-packages Скилл link-workspace-packages для Claude Code настраивает зависимости между пакетами монорепозитория через менеджер пакетов и разрешает импорты из соседних пакетов. CX Codex +1 3 200установок nx-import Скилл nx-import помогает переносить сторонние репозитории и папки в существующий монорепозиторий Nx с сохранением истории Git. CX Codex +1 2 800установок monitor-ci Скилл monitor-ci отслеживает пайплайны Nx Cloud CI и запускает сценарии самовосстановления упавших билдов через MCP. Пригодится при частых прогонах тестов и PR. CX Codex +1 2 000установок nx-cloud-cache-investigator Скилл nx-cloud-cache-investigator для Claude Code разбирает сбои кэша задач Nx и сравнивает выполнения. Запускается по вопросу о промахе кэша, восстановлении артефакта или устаревшем результате. CX Codex +1 127установок nx-cloud-ci-failure-review Скилл nx-cloud-ci-failure-review для Claude Code разбирает сбои CI в Nx Cloud и объединяет повторяющиеся причины по подтверждённым данным. Запускается по запросу о падениях пайплайнов, CIPE или отчёте за последние 24 часа. CX Codex +1 125установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой