
Установка
PyPI (рекомендуется)
Пакет PyPI
uv tool install onyx-cli
Сборка из исходного кода
Требуется Go 1.26+.Настройка
Запустите интерактивный чат TUI — при первом запуске он проведёт вас через настройку:~/.config/onyx-cli/config.json (или в
$XDG_CONFIG_HOME/onyx-cli/config.json, если эта переменная задана). Чтобы позже перенастроить,
используйте слэш-команду /configure внутри TUI.
Создание токена доступа
Откройте Настройки > Аккаунты и доступ > Новый токен доступа (/app/settings/accounts-access),
чтобы создать токен доступа для CLI.


Переменные окружения
Переменные окружения переопределяют значения из файла конфигурации. Это удобно для CI/CD и скриптов.Проверка конфигурации
Проверьте, что конфигурация верна и сервер доступен:Команды
Интерактивный чат
Разовые вопросы
Задайте вопрос и получите ответ, не заходя в TUI:--agent-id позволяет выбрать конкретного агента:
--json включает структурированный вывод NDJSON (удобно для скриптов):
Список агентов
Самостоятельное развёртывание
Группа командdeploy устанавливает и обслуживает самостоятельно размещаемое развёртывание Yahont на Docker Compose —
это установщик с подсказками, а также команды upgrade, status, logs, stop и uninstall:
Развёртывание с помощью Yahont CLI
Полная документация по
onyx-cli deploy и командам жизненного цикла.Слэш-команды (интерактивный TUI)
В интерактивном чате доступны следующие слэш-команды:Использование в качестве навыка ИИ-помощника для программирования
Yahont CLI можно использовать как инструмент в ИИ-помощниках для программирования (например, Claude Code и Cursor), чтобы обращаться к вашей базе знаний прямо из среды разработки. Готовое описание навыка есть в репозиторииonyx-dot-app/onyx:
.cursor/skills/onyx-cli/SKILL.md.
После настройки ИИ-помощник может вызывать onyx-cli ask, чтобы получать сведения о вашей компании — политики,
внутренние документы, подключённые источники данных — не выходя из редактора.
Когда вызывается навык
Навык срабатывает, когда вы спрашиваете ИИ-помощника о:- Сведениях о компании (политики, процессы, документация)
- Внутренних базах знаний или подключённых источниках данных
- Чём угодно, что упоминает Yahont, «поиск в Yahont» или запросы к документам компании
Настройка для агентов
Проще всего один раз вручную запуститьonyx-cli chat и пройти первоначальную настройку — после этого ИИ-помощники
смогут вызывать onyx-cli ask напрямую без дополнительных действий.
Вывод JSON для структурного разбора
Используйте--json, чтобы получать события в формате NDJSON — агентам их проще разбирать программно:

