---
title: Использование CLI
url: https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/using
description: Структура команд, форматы вывода, преобразования GJSON, тела запросов и отладка для CLI ant.
---

На этой странице описаны механизмы ввода и вывода CLI `ant`, которые применяются ко всем конечным точкам. Чтобы установить CLI и пройти аутентификацию, см. [Быстрый старт](https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/quickstart). Чтобы объединять команды в цепочки и управлять версиями ресурсов, см. [Скрипты и автоматизация с CLI](https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/scripting).

## Структура команд

Команды следуют шаблону `resource action`. Вложенные ресурсы разделяются двоеточиями:

```text wrap
ant <resource>[:<subresource>] <action> [flags]
```

Выполните `ant --help`, чтобы получить полный список ресурсов, или добавьте `--help` к любой подкоманде, чтобы увидеть её флаги.

Ресурсы в бета-версии (включая агентов, сеансы, развёртывания и окружения) находятся под префиксом `beta:`. Команды в этом пространстве имён автоматически отправляют соответствующий заголовок `anthropic-beta` для данного ресурса, поэтому вам не нужно передавать его самостоятельно. Используйте `--beta <header>` только для переопределения значения по умолчанию (например, чтобы перейти на другую версию схемы).

```bash
ant models list
ant messages create --model claude-opus-5-5 --max-tokens 1024 ...
ant beta:agents retrieve --agent-id agent_01...
ant beta:sessions:events list --session-id session_01...
```

### Глобальные флаги

| Флаг                                  | Описание                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `--profile`                           | Именованный профиль для этого вызова (эквивалентно установке `ANTHROPIC_PROFILE`). См. [Переключение между рабочими пространствами](https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/authentication#switch-between-workspaces).                                                                                                                                                                                                                                                                                                                          |
| `--api-key-stdin`                     | Считать ключ API из стандартного ввода. Флаг считывает весь стандартный ввод, поэтому передавайте тело запроса с помощью [флагов](https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/using#flags).                                                                                                                                                                                                                                                                                                                                                         |
| `--auth-token-stdin`                  | Считать bearer-токен из стандартного ввода. Флаг считывает весь стандартный ввод, поэтому передавайте тело запроса с помощью [флагов](https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/using#flags).                                                                                                                                                                                                                                                                                                                                                     |
| `--format`                            | Формат вывода: `auto`, `json`, `jsonl`, `yaml`, `pretty`, `raw`, `explore`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `--transform`                         | Отфильтровать или изменить структуру ответа с помощью [пути GJSON](https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/using#transform-output-with-gjson)                                                                                                                                                                                                                                                                                                                                                                                                   |
| `-r`, `--raw-output`                  | Выводить строковые результаты без окружающих кавычек, как `jq -r`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `--base-url`                          | Переопределить базовый URL API                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `--workspace-id`                      | Необязательно. Идентификатор рабочего пространства (`wrkspc_...`), отправляемый в заголовке `anthropic-workspace-id`, для ключей API с доступом к нескольким рабочим пространствам (эквивалентно установке `ANTHROPIC_WORKSPACE_ID`). См. [Выбор рабочего пространства](https://platform.claude.com/docs/ru/manage-claude/authentication#select-a-workspace). Команды [Admin API](https://platform.claude.com/docs/ru/manage-claude/admin-api) принимают собственный `--workspace-id`, который вместо этого указывает рабочее пространство, которым они управляют. |
| `--debug`                             | Выводить полный HTTP-запрос и ответ в stderr                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `--format-error`, `--transform-error` | То же, что `--format` и `--transform`, но применяется к [ответам с ошибками](https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/scripting#inspect-errors)                                                                                                                                                                                                                                                                                                                                                                                                  |

## Форматы вывода

`auto` выводит JSON в отформатированном виде и используется по умолчанию для команд, которые создают или изменяют ресурсы. Команды получения списка и извлечения по умолчанию открывают [интерактивный обозреватель](https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/using#interactive-explorer) при выводе в терминал и выводят отформатированный JSON при передаче через конвейер. Переопределите любое из этих значений по умолчанию с помощью `--format`:

```bash
ant models retrieve --model-id claude-opus-5-5 --format yaml
```

```yaml Output
type: model
id: claude-opus-5-5
display_name: Claude Opus 5.5
created_at: "2026-09-22T00:00:00Z"
...
```

Конечные точки списков автоматически выполняют пагинацию. В форматах по умолчанию каждый элемент записывается отдельно (один компактный объект JSON на строку в режиме `jsonl`, поток документов YAML в режиме `yaml`), что позволяет без проблем передавать вывод в `head`, `grep` и фильтры `--transform`.

### Интерактивный обозреватель

Обозреватель — это TUI со сворачиванием и поиском для просмотра больших ответов. Клавиши со стрелками разворачивают и сворачивают узлы, `/` запускает поиск, `q` выполняет выход. Команды получения списка и извлечения открывают его по умолчанию при подключении к терминалу. Передайте `--format explore`, чтобы открыть его явно:

```bash
ant models list --format explore
```

## Преобразование вывода с помощью GJSON

Используйте `--transform`, чтобы изменить структуру ответов перед выводом. Выражение представляет собой [путь GJSON](https://github.com/tidwall/gjson/blob/master/SYNTAX.md). Для конечных точек списков преобразование применяется к каждому элементу по отдельности, а не к обёртке:

```bash
ant beta:agents list \
  --transform "{id,name,model}" \
  --format jsonl
```

```jsonl Output
{"id": "agent_011CYm1BLqPX...", "name": "Docs CLI Test Agent", "model": "claude-opus-5-5"}
{"id": "agent_011CYkVwfaEt...", "name": "Coffee Making Assistant", "model": "claude-opus-5-5"}
{"id": "agent_011CYixHhtUP...", "name": "Coding Assistant", "model": "claude-opus-5-5"}
```

### Извлечение скалярного значения

Чтобы получить одно поле в виде строки без кавычек (например, идентификатор только что созданного ресурса), используйте `--transform` вместе с `--raw-output`. Результат выводится без кавычек JSON и готов к присвоению переменной оболочки:

```bash
AGENT_ID=$(ant beta:agents create \
  --name "My Agent" \
  --model '{id: claude-opus-5-5}' \
  --transform id --raw-output)
```

<Note>
  `--raw-output` отличается от `--format raw`. `--raw-output` удаляет кавычки JSON из строковых результатов, как `jq -r`. `--format raw` выводит необработанные байты JSON тела ответа без автоматической пагинации; на конечных точках списков он применяет `--transform` к обёртке пагинации, а не к каждому элементу.
</Note>

## Передача тел запросов

Подходящий механизм ввода зависит от структуры данных: используйте **флаги** для скалярных полей и коротких структурированных значений, передавайте документ через **stdin** для вложенных или многострочных тел и используйте **ссылки `@file`**, чтобы подставить содержимое файла в любое строковое или двоичное поле.

### Флаги

Скалярные поля напрямую соответствуют флагам. Структурированные поля принимают упрощённый синтаксис, похожий на YAML (ключи без кавычек, необязательные кавычки вокруг строк), или строгий JSON:

```bash
ant beta:sessions create \
  --agent '{type: agent, id: agent_011CYm1BLqPXpQRk5khsSXrs, version: 1}' \
  --environment-id env_01595EKxaaTTGwwY3kyXdtbs \
  --title "CLI docs test session"
```

Повторяемые флаги формируют массивы. Каждый `--tool` или `--event` добавляет один элемент:

```bash
ant beta:agents create \
  --name "Research Agent" \
  --model '{id: claude-opus-5-5}' \
  --tool '{type: agent_toolset_20260401}' \
  --tool '{type: custom, name: search_docs, input_schema: {type: object, properties: {query: {type: string}}}}'
```

### Stdin

Передайте документ JSON или YAML в stdin, чтобы указать полное тело запроса. Поля из stdin объединяются с флагами, причём флаги имеют приоритет. Здесь `version` — это токен оптимистичной блокировки, возвращённый предыдущим `retrieve`, а `$AGENT_ID` был получен так, как описано в разделе [Извлечение скалярного значения](https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/using#extract-a-scalar):

```bash
echo '{"description": "Updated test agent.", "version": 1}' | \
  ant beta:agents update --agent-id "$AGENT_ID"
```

Heredoc работают так же и удобны для многострочного YAML. Заключите разделитель в кавычки (как в `<<'YAML'`), чтобы отключить подстановку переменных внутри тела.

```bash
ant beta:agents create <<'YAML'
name: Research Agent
model: claude-opus-5-5
system: |
  You are a research assistant. Cite sources for every claim.
tools:
  - type: agent_toolset_20260401
YAML
```

### Ссылки на файлы

Флаги, принимающие путь к файлу, например `--file` в команде загрузки, принимают путь без префикса:

```bash
ant files upload --file ./report.pdf
```

Чтобы подставить содержимое файла в поле со строковым значением, добавьте к пути префикс `@`:

```bash
ant beta:agents create \
  --name "Researcher" --model '{id: claude-opus-5-5}' \
  --system @./prompts/researcher.txt
```

Внутри структурированных значений флагов заключайте путь в кавычки. Чтобы отправить PDF в Messages API:

```bash
ant messages create \
  --model claude-opus-5-5 \
  --max-tokens 1024 \
  --message '{role: user, content: [
    {type: document, source: {type: base64, media_type: application/pdf, data: "@./scan.pdf"}},
    {type: text, text: "Extract the text from this scanned document."}
  ]}'
```

CLI определяет тип файла и автоматически кодирует двоичные файлы в base64. Чтобы принудительно задать определённую кодировку, используйте `@file://` для обычного текста или `@data://` для base64. Экранируйте буквальный начальный `@` обратной косой чертой (`\@username`).

## Отладка

Добавьте `--debug` к любой команде, чтобы вывести точный HTTP-запрос и ответ (заголовки и тело) в stderr. Ключи API скрываются.

```bash
ant --debug beta:agents list
```

```text Output wrap
GET /v1/agents?beta=true HTTP/1.1
Host: api.anthropic.com
Anthropic-Beta: managed-agents-2026-04-01
Anthropic-Version: 2026-10-21
Authorization: Bearer <REDACTED>
...
```

## Доступные ресурсы

Все ресурсы API, предоставляемые CLI, описаны в [справочнике API](https://platform.claude.com/docs/ru/api/cli/messages/create). Чтобы получить локальный список, выполните `ant --help` и добавьте `--help` к любой подкоманде, чтобы увидеть её флаги и параметры.

## Следующие шаги

<CardGroup cols={3}>
  <Card title="Скрипты и автоматизация с CLI" icon="code" href="https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/scripting">
    Управление версиями ресурсов API, шаблоны скриптов и использование из Claude Code
  </Card>

  <Card title="Справочник API" icon="book" href="https://platform.claude.com/docs/ru/api/cli/messages/create">
    Параметры конкретных конечных точек, поля запросов и схемы ответов
  </Card>

  <Card title="Варианты аутентификации CLI" icon="lock" href="https://platform.claude.com/docs/ru/cli-sdks-libraries/cli/authentication">
    Ключи API, хосты без графического интерфейса, несколько рабочих пространств и именованные профили
  </Card>
</CardGroup>