@artiroute/cli
v0.1.2
Published
ArtiRoute orchestrator CLI for self-hosted on-prem installs
Readme
@artiroute/cli
Оркестратор для self-hosted развёртывания ArtiRoute — AI workspace для командных материалов и знаний.
CLI устанавливает и обновляет runtime-пакеты из приватного реестра лицензий, настраивает PostgreSQL и запускает backend с AI-сервисом в контуре вашей организации. Облачного «войти на artiroute.com» нет.
Документация: Развёртывание on-prem · Администрирование
Требования
| Компонент | Версия | |-----------|--------| | Node.js | 20.x или новее | | PostgreSQL | 14+ (рекомендуется 16) | | Лицензионный ключ | Выдаётся поставщиком |
Дополнительно по потребностям: OnlyOffice Document Server, ffmpeg (транскрипция), доступ к API моделей ИИ. Подробнее — в документации.
Установка
npm install -g @artiroute/cli
artiroute --versionБыстрый старт
# 1. Установка: лицензия, PostgreSQL, runtime-пакеты
artiroute install
# 2. Запуск backend и AI-сервиса (логи в этом терминале)
artiroute startПосле запуска откройте backend в браузере (по умолчанию http://127.0.0.1:8080) и пройдите первичную настройку.
Неинтерактивная установка
artiroute install --yes \
--key "ВАШ-ЛИЦЕНЗИОННЫЙ-КЛЮЧ" \
--pg-host 127.0.0.1 \
--pg-port 5432 \
--pg-db artiroute \
--pg-user postgres \
--pg-password "ваш-пароль" \
--backend-port 8080 \
--ai-port 9090Секреты приложения можно задать до install:
export SESSION_SECRET="…"
export BACKEND_SERVICE_TOKEN="…"
export EXTENSION_SECRETS_KEY="…"Команды
| Команда | Описание |
|---------|----------|
| artiroute activate --key <ключ> | Активировать лицензию и настроить доступ к приватному npm-реестру |
| artiroute install | Активация (если нужно), PostgreSQL, порты, установка runtime-пакетов |
| artiroute start | Запустить backend и AI-сервис на переднем плане |
| artiroute stop | Остановить сервисы |
| artiroute status | Версии, порты, состояние процессов и лицензии |
| artiroute update-check | Проверить доступные обновления |
| artiroute update | Установить последние runtime-пакеты из реестра |
| artiroute update --force | Переустановить пакеты даже при совпадении версий |
| artiroute home | Показать каталог установки |
Обновление
artiroute update-check
artiroute update
artiroute stop
artiroute startМиграции схемы БД применяются при старте backend автоматически.
Каталог установки
По умолчанию ~/.artiroute (переопределяется через ARTIROUTE_HOME):
~/.artiroute/
config.json # лицензия, реестр, установленные версии
config.env # PostgreSQL, порты, секреты сервисов
.npmrc # токен приватного реестра
packages/ # @artiroute/backend-runtime, @artiroute/ai-agent
data/ # файлы артефактов и данные приложения
run/ # pid-файлы и логиПеременные окружения
| Переменная | Назначение |
|------------|------------|
| ARTIROUTE_HOME | Каталог установки (по умолчанию ~/.artiroute) |
| ARTIROUTE_LICENSE_SERVER_URL | URL сервера лицензий (если не зашит в сборку CLI) |
| SESSION_SECRET | Секрет сессий веб-приложения |
| BACKEND_SERVICE_TOKEN / GRAPHQL_API_KEY | Служебный ключ между сервисами |
| EXTENSION_SECRETS_KEY | Ключ шифрования секретов расширений |
Порты по умолчанию
| Сервис | Порт | |--------|------| | Backend (веб-интерфейс, API) | 8080 | | AI agent | 9090 |
Задаются при artiroute install или в config.env.
Продакшен
artiroute start держит процессы на переднем плане. Для production обычно настраивают systemd, Windows Service или process manager; логи также пишутся в run/ внутри ARTIROUTE_HOME.
Перед сервисом часто ставят reverse proxy (HTTPS, корпоративный домен). OnlyOffice и LDAP/Keycloak — см. интеграции.
Связанные материалы
- Развёртывание on-prem — железо, PostgreSQL, OnlyOffice, ffmpeg
- Первичная настройка
- Пользователи и роли
- Настройка ИИ
- Лицензия
Лицензия
Проприетарное ПО. Использование по лицензионному соглашению с поставщиком.
Контакты: zebrains.ru/contacts
