Использование 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-5-5 --max-tokens 1024 ...
ant beta:agents retrieve --agent-id agent_01...
ant beta:sessions:events list --session-id session_01...

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

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

Формат auto выводит JSON в удобочитаемом виде. Он используется по умолчанию для команд, которые создают или изменяют ресурсы. Команды получения списков и отдельных ресурсов по умолчанию открывают интерактивный обозреватель, если вывод идёт в терминал. Если вывод передаётся по конвейеру, они выводят JSON в удобочитаемом виде. Любое из этих значений по умолчанию можно переопределить с помощью --format:

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

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

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

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

Обозреватель — это TUI со сворачиванием и поиском для просмотра больших ответов. Клавиши со стрелками разворачивают и сворачивают узлы, / выполняет поиск, q завершает работу. Команды получения списка и извлечения открывают его по умолчанию при подключении к терминалу. Передайте --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-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, и его можно сразу присвоить переменной оболочки:

AGENT_ID=$(ant beta:agents create \
  --name "My Agent" \
  --model '{id: claude-opus-5-5}' \
  --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-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 — это токен «optimistic locking» (оптимистичной блокировки), полученный ранее командой 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-5-5
system: |
  You are a research assistant. Cite sources for every claim.
tools:
  - type: agent_toolset_20260401
YAML

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

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

ant files upload --file ./report.pdf

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

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

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

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."}
  ]}' \
  --transform 'content.#(type=="text").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 к любой подкоманде, чтобы увидеть её флаги и параметры.

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