> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yahont.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> Работа с Yahont из командной строки

![Терминальный интерфейс Yahont CLI](https://mintcdn.com/yahont-ai/UKtfkv0aQHzrYqTA/assets/overview/cli/cli_hero.png?fit=max\&auto=format\&n=UKtfkv0aQHzrYqTA\&q=85\&s=08ef179b2ad231463c2cfe004eb238cf)

Yahont CLI — это терминальный интерфейс для общения с вашими агентами Yahont и запросов к базе знаний.
Он написан на Go с использованием [Bubble Tea](https://github.com/charmbracelet/bubbletea)
и предлагает как интерактивный TUI, так и неинтерактивные команды для скриптов и автоматизации.

## Установка

### PyPI (рекомендуется)

```shell theme={null}
uv tool install onyx-cli
```

Или через pip:

```shell theme={null}
pip install onyx-cli
```

> [card] [Пакет PyPI](https://pypi.org/project/onyx-cli/)
>
> uv tool install onyx-cli

### Сборка из исходного кода

Требуется [Go 1.26+](https://go.dev/dl/).

```shell theme={null}
git clone --depth 1 https://github.com/onyx-dot-app/onyx.git
cd onyx/cli
go build -o onyx-cli .
sudo mv onyx-cli /usr/local/bin/
```

## Настройка

Запустите интерактивный чат TUI — при первом запуске он проведёт вас через настройку:

```shell theme={null}
onyx-cli chat
```

Он запросит URL вашего сервера Yahont и персональный токен доступа (PAT),
проверит подключение и сохранит конфигурацию в `~/.config/onyx-cli/config.json` (или в
`$XDG_CONFIG_HOME/onyx-cli/config.json`, если эта переменная задана). Чтобы позже перенастроить,
используйте слэш-команду `/configure` внутри TUI.

### Создание токена доступа

Откройте **Настройки > Аккаунты и доступ > Новый токен доступа** (`/app/settings/accounts-access`),
чтобы создать токен доступа для CLI.

![Страница «Аккаунты и доступ» с разделом токенов доступа](https://mintcdn.com/yahont-ai/UKtfkv0aQHzrYqTA/assets/overview/cli/access_tokens.png?fit=max\&auto=format\&n=UKtfkv0aQHzrYqTA\&q=85\&s=d30b6f5e9d1a4924cfc31b60bca3961f)

![Окно создания токена доступа с названием токена и параметрами срока действия](https://mintcdn.com/yahont-ai/UKtfkv0aQHzrYqTA/assets/overview/cli/create_access_token.png?fit=max\&auto=format\&n=UKtfkv0aQHzrYqTA\&q=85\&s=6418de0499e4a763bddc88bb95088638)

### Переменные окружения

Переменные окружения переопределяют значения из файла конфигурации. Это удобно для CI/CD и скриптов.

| Переменная | Обязательна | Описание |
| - | - | - |
| `ONYX_SERVER_URL` | Нет | Базовый URL сервера (по умолчанию: `https://cloud.yahont.ai`) |
| `ONYX_PAT` | Нет | Персональный токен доступа для аутентификации (обязателен, если нет файла конфигурации) |
| `ONYX_PERSONA_ID` | Нет | ID агента (персонажа) по умолчанию |

### Проверка конфигурации

Проверьте, что конфигурация верна и сервер доступен:

```shell theme={null}
onyx-cli validate-config
```

## Команды

| Команда | Описание |
| - | - |
| `onyx-cli chat` | Запустить интерактивный чат TUI (включает первоначальную настройку) |
| `onyx-cli ask` | Задать разовый вопрос (неинтерактивно) |
| `onyx-cli search` | Искать по знаниям компании и получить ранжированные документы |
| `onyx-cli agents` | Показать список доступных агентов |
| `onyx-cli validate-config` | Проверить конфигурацию и протестировать подключение |
| `onyx-cli deploy` | Установить и обслуживать самостоятельно размещаемое развёртывание Yahont |

### Интерактивный чат

```shell theme={null}
onyx-cli chat
```

Открывает полноэкранный терминальный интерфейс для диалога с вашими агентами Yahont.

### Разовые вопросы

Задайте вопрос и получите ответ, не заходя в TUI:

```shell theme={null}
onyx-cli ask "What is our company's PTO policy?"
```

Параметр `--agent-id` позволяет выбрать конкретного агента:

```shell theme={null}
onyx-cli ask --agent-id 5 "Summarize our Q4 roadmap"
```

Параметр `--json` включает структурированный вывод NDJSON (удобно для скриптов):

```shell theme={null}
onyx-cli ask --json "List all active API integrations"
```

| Флаг | Описание |
| - | - |
| `--agent-id <int>` | ID используемого агента (переопределяет значение по умолчанию) |
| `--json` | Выводить события NDJSON вместо обычного текста |

### Список агентов

```shell theme={null}
onyx-cli agents
onyx-cli agents --json
```

Выводит таблицу с ID, названиями и описаниями доступных агентов.

### Самостоятельное развёртывание

Группа команд `deploy` устанавливает и обслуживает самостоятельно размещаемое развёртывание Yahont на Docker Compose —
это установщик с подсказками, а также команды `upgrade`, `status`, `logs`, `stop` и `uninstall`:

```shell theme={null}
onyx-cli deploy install
```

> [card] [Развёртывание с помощью Yahont CLI](https://docs.yahont.ai/deployment/local/yahont_cli.md)
>
> Полная документация по `onyx-cli deploy` и командам жизненного цикла.

## Слэш-команды (интерактивный TUI)

В интерактивном чате доступны следующие слэш-команды:

| Команда | Описание |
| - | - |
| `/help` | Показать справку |
| `/new` | Начать новую сессию чата |
| `/agent` | Показать агентов и переключиться между ними |
| `/attach <path>` | Прикрепить файл к следующему сообщению |
| `/sessions` | Показать недавние сессии чата |
| `/clear` | Очистить отображение чата |
| `/configure` | Повторно запустить настройку подключения |
| `/connectors` | Открыть коннекторы в браузере |
| `/settings` | Открыть настройки в браузере |
| `/quit` | Выйти из Yahont CLI |

## Использование в качестве навыка ИИ-помощника для программирования

Yahont CLI можно использовать как инструмент в ИИ-помощниках для программирования (например, Claude Code и Cursor),
чтобы обращаться к вашей базе знаний прямо из среды разработки.
Готовое описание навыка есть в репозитории `onyx-dot-app/onyx`:
[`.cursor/skills/onyx-cli/SKILL.md`](https://github.com/onyx-dot-app/onyx/blob/main/cli/internal/embedded/SKILL.md).

После настройки ИИ-помощник может вызывать `onyx-cli ask`, чтобы получать сведения о вашей компании — политики,
внутренние документы, подключённые источники данных — не выходя из редактора.

### Когда вызывается навык

Навык срабатывает, когда вы спрашиваете ИИ-помощника о:

* Сведениях о компании (политики, процессы, документация)
* Внутренних базах знаний или подключённых источниках данных
* Чём угодно, что упоминает Yahont, «поиск в Yahont» или запросы к документам компании

Он **не** используется для общих вопросов по программированию и вопросов о коде в текущем репозитории.

### Настройка для агентов

Проще всего один раз вручную запустить `onyx-cli chat` и пройти первоначальную настройку — после этого ИИ-помощники
смогут вызывать `onyx-cli ask` напрямую без дополнительных действий.

```shell theme={null}
onyx-cli chat
```

Либо можно настроить через переменные окружения,
которые переопределяют файл конфигурации и удобны для CI/CD и изолированных сред:

```shell theme={null}
export ONYX_SERVER_URL="https://your-yahont-server.com"
export ONYX_PAT="your-pat"
```

### Вывод JSON для структурного разбора

Используйте `--json`, чтобы получать события в формате NDJSON — агентам их проще разбирать программно:

```shell theme={null}
onyx-cli ask --json "List all active API integrations"
```

| Тип события | Описание |
| - | - |
| `message_delta` | Токен содержимого — для полного ответа объедините все поля `content` |
| `stop` | Поток завершён |
| `error` | Ошибка с полем сообщения `error` |
| `search_tool_start` | Yahont начал поиск документов |
| `citation_info` | Ссылка на источник с полями `citation_number` и `document_id` |

## Сочетания клавиш

| Клавиша | Действие |
| - | - |
| `Enter` | Отправить сообщение |
| `Escape` | Отменить текущую генерацию |
| `Ctrl+O` | Показать или скрыть ссылки на источники |
| `Ctrl+D` | Выйти (нажмите дважды) |
| `Scroll` / `Shift+Up/Down` | Прокрутка истории чата |
| `Page Up` / `Page Down` | Прокрутка на пол-экрана |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.