Использование CLI

На этой странице рассматривается механика ввода и вывода CLI ant, применимая ко всем конечным точкам. Об установке и аутентификации см. Быстрый старт. О связывании команд в цепочки и управлении версиями ресурсов см. Скрипты и автоматизация CLI.

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

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

ant <resource>[:<subresource>] <action> [flags]

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

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

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

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

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

auto выводит JSON в удобочитаемом виде и используется по умолчанию для команд, создающих или изменяющих ресурсы. Команды list и retrieve по умолчанию используют интерактивный обозреватель при выводе в терминал и удобочитаемый JSON при передаче через конвейер. Переопределите любое из этих значений по умолчанию с помощью --format:

ant models retrieve --model-id claude-opus-4-8 --format yaml

type: model
id: claude-opus-4-8
display_name: Claude Opus 4.8
created_at: "2026-02-04T00:00:00Z"
...

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

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

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

ant models list --format explore

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

Используйте --transform для преобразования ответов перед выводом. Выражение представляет собой путь GJSON. Для конечных точек списков преобразование применяется к каждому элементу по отдельности, а не к обёртке:

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

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

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

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

AGENT_ID=$(ant beta:agents create \
  --name "My Agent" \
  --model '{id: claude-sonnet-4-6}' \
  --transform id --raw-output)

printf '%s\n' "$AGENT_ID"

agent_011CYm1BLqPXpQRk5khsSXrs

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

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

Флаги

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

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

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

ant beta:agents create \
  --name "Research Agent" \
  --model '{id: claude-opus-4-8}' \
  --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 был получен, как описано в разделе Извлечение скалярного значения:

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

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

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

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

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

ant beta:files upload --file ./report.pdf

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

ant beta:agents create \
  --name "Researcher" --model '{id: claude-sonnet-4-6}' \
  --system @./prompts/researcher.txt

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

ant messages create \
  --model claude-opus-4-8 \
  --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."}
  ]}' \
  --transform 'content.0.text' --raw-output

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

Отладка

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

ant --debug beta:agents list

GET /v1/agents?beta=true HTTP/1.1
Host: api.anthropic.com
Anthropic-Beta: managed-agents-2026-04-01
Anthropic-Version: 2023-06-01
X-Api-Key: <REDACTED>
...

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

Каждый ресурс API, предоставляемый CLI, задокументирован в справочнике API. Для локального списка выполните ant --help и добавьте --help к любой подкоманде, чтобы увидеть её флаги и параметры.