> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://agentinbox.space/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://agentinbox.space/_mcp/server.

# CLI

> Официальный интерфейс командной строки Agent Inbox

## Начало работы

CLI Agent Inbox позволяет напрямую вызывать API Agent Inbox из терминала: создавать ящики, отправлять сообщения, управлять тредами и не только — без написания кода.

### Установка

Установка через npm:

```bash
npm install -g agentinbox-cli
```

### Аутентификация

Задайте API-ключ в переменной окружения:

```bash
export AGENTINBOX_API_KEY=am_us_xxx
```

Или передайте его флагом `--api-key`. Ключ выдаётся в [консоли](https://agentinbox-ru.vercel.app/)[ Agent Inbox](https://console.agentinbox.space).

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

Команды следуют шаблону:

```bash
agentinbox [resource] <command> [flags...]
```

Для вложенных ресурсов можно использовать синтаксис с двоеточием:

```bash
agentinbox inboxes:messages send --inbox-id inb_xxx --to user@example.com --subject "Hello" --text "Hi there"
```

Для любой команды доступна справка: `--help`.

### Примеры

```bash
# List inboxes
agentinbox inboxes list

# Create an inbox
agentinbox inboxes create --display-name "My Inbox"

# Send a message
agentinbox inboxes:messages send \
  --inbox-id inb_xxx \
  --to user@example.com \
  --subject "Hello" \
  --text "Hi there"

# List threads
agentinbox inboxes:threads list --inbox-id inb_xxx

# Create a webhook
agentinbox webhooks create \
  --event-type message.received \
  --url https://example.com/webhook
```

## Возможности

CLI покрывает:

* **Почтовые ящики:** создание, список, обновление и удаление
* **Сообщения:** отправка, ответ, пересылка и получение писем
* **Треды:** список и управление цепочками писем
* **Черновики:** создание, обновление, отправка и удаление
* **Вебхуки:** создание и управление конечными точками
* **Домены:** добавление и проверка собственных доменов
* **Pods:** управление pod-ресурсами и их ящиками
* **API-ключи:** создание и управление ключами

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

| Флаг        | Описание                                                  |
| ----------- | --------------------------------------------------------- |
| `--api-key` | API-ключ (или переменная `AGENTINBOX_API_KEY`)            |
| `--format`  | Формат вывода: `json`, `yaml`, `pretty`, `raw`, `explore` |
| `--debug`   | Подробный лог                                             |
| `--help`    | Справка                                                   |
| `--version` | Версия                                                    |

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

Вид результата задаётся флагом `--format`:

* `json` — вывод в JSON (по умолчанию)
* `yaml` — вывод в YAML
* `pretty` — удобочитаемый формат
* `raw` — сырой ответ API
* `explore` — интерактивный просмотр

Также можно использовать `--transform` с синтаксисом [GJSON](https://github.com/tidwall/gjson) для запросов и фильтрации вывода.

## Навык для ИИ

CLI доступен как навык AgentSkills, чтобы ассистенты по коду могли вызывать его за вас. Установка:

```bash
openclaw skills install agentinbox/agentinbox-skills/agentinbox-cli
```

Работает с OpenClaw, Claude Code, Cursor, Codex и другими совместимыми инструментами. Подробнее — на странице [Skills](/integrations/skills).