Skip to content
Эта страница создана и переведена с помощью ИИ. Если вы заметили неточности, помогите нам улучшить её. Редактировать на GitHub

Мастер настройки

Команда prx onboard создаёт начальный файл конфигурации, проводя вас через выбор провайдера, ввод API-ключа, выбор модели и настройку бэкенда памяти. Это рекомендуемый способ первоначальной настройки PRX.

Что делает Onboard

При запуске prx onboard мастер выполняет следующие шаги:

  1. Выбор LLM-провайдера — предлагает выбрать из 9 поддерживаемых провайдеров (Anthropic, OpenAI, Google Gemini, Ollama, OpenRouter и т.д.)
  2. Сохранение API-ключа — безопасно записывает учётные данные провайдера в файл конфигурации
  3. Получение доступных моделей — запрашивает API провайдера для получения списка моделей, к которым у вас есть доступ
  4. Установка модели по умолчанию — позволяет выбрать модель, используемую по умолчанию
  5. Настройка бэкенда памяти — выбор между Markdown (файловый), SQLite или PostgreSQL
  6. Запись файла конфигурации — создаёт ~/.config/openprx/openprx.toml с вашими настройками

После настройки PRX готов к запуску с помощью prx daemon или prx chat.

Интерактивный режим

По умолчанию используется быстрая настройка, которая задаёт только основные вопросы. Для полного интерактивного мастера, проходящего через каждый раздел конфигурации, используйте флаг --interactive:

bash
prx onboard --interactive

Интерактивный мастер включает дополнительную конфигурацию:

  • Настройки хоста и порта шлюза
  • Предварительная настройка каналов (Telegram, Discord и т.д.)
  • Уровень безопасности и автономности
  • Каталог рабочей области
  • Настройки наблюдаемости

Быстрая настройка (по умолчанию)

По умолчанию prx onboard запускает упрощённую быструю настройку:

bash
prx onboard

Запрашивается только провайдер, API-ключ и модель — ничего более. Все остальные параметры используют разумные значения по умолчанию.

Быстрая настройка с флагами

Пропустите интерактивные запросы полностью, передав флаги:

bash
prx onboard \
  --provider anthropic \
  --api-key sk-ant-api03-xxxxxxxxxxxx \
  --model claude-sonnet-4-20250514

Доступные флаги:

ФлагОписаниеПример
--providerИмя LLM-провайдераanthropic, openai, ollama, openrouter
--api-keyAPI-ключ или учётные данные провайдераsk-ant-..., sk-...
--modelИдентификатор модели по умолчаниюclaude-sonnet-4-20250514, gpt-4o
--memoryБэкенд памятиmarkdown, sqlite, postgres
--interactiveЗапуск полного интерактивного мастера(без значения)
--channels-onlyПовторный запуск только мастера восстановления каналов(без значения)

Примеры

Anthropic Claude со значениями по умолчанию:

bash
prx onboard --provider anthropic --api-key "$ANTHROPIC_API_KEY"

Локальный Ollama (API-ключ не требуется):

bash
prx onboard --provider ollama --model llama3.2

OpenRouter с конкретной моделью:

bash
prx onboard --provider openrouter --api-key "$OPENROUTER_API_KEY" --model anthropic/claude-sonnet-4-20250514

OpenAI с памятью SQLite:

bash
prx onboard --provider openai --api-key "$OPENAI_API_KEY" --model gpt-4o --memory sqlite

Файл конфигурации

Мастер настройки записывает конфигурацию в:

~/.config/openprx/openprx.toml

В Linux это соответствует спецификации XDG Base Directory. В macOS используется ~/Library/Application Support/openprx/openprx.toml, если переменная XDG_CONFIG_HOME не задана.

Пример сгенерированной конфигурации

После выполнения prx onboard --provider anthropic --model claude-sonnet-4-20250514 сгенерированная конфигурация выглядит так:

toml
# OpenPRX Configuration
# Generated by: prx onboard

# ── Provider ──────────────────────────────────────────────
default_provider = "anthropic"
default_model = "claude-sonnet-4-20250514"
default_temperature = 0.7
api_key = "sk-ant-api03-xxxxxxxxxxxx"

# ── Workspace ─────────────────────────────────────────────
workspace_dir = "~/.local/share/openprx"

# ── Memory ────────────────────────────────────────────────
[memory]
backend = "markdown"
# path defaults to workspace_dir/memory

# ── Gateway ───────────────────────────────────────────────
[gateway]
host = "127.0.0.1"
port = 3120

# ── Channels ──────────────────────────────────────────────
[channels]
cli = true

# ── Security ──────────────────────────────────────────────
[security]
autonomy = "supervised"

Этот файл можно редактировать в любое время. PRX поддерживает горячую перезагрузку — большинство изменений вступают в силу без перезапуска демона.

Разделы конфигурации

Файл конфигурации поддерживает следующие разделы верхнего уровня:

РазделНазначение
default_providerLLM-провайдер, используемый по умолчанию
default_modelМодель, используемая по умолчанию
api_keyУчётные данные API провайдера
[memory]Бэкенд памяти и настройки хранилища
[gateway]Конфигурация шлюза HTTP/WebSocket
[channels]Конфигурации каналов обмена сообщениями
[channels.telegram]Настройки Telegram-бота
[channels.discord]Настройки Discord-бота
[security]Уровень автономности, песочница, политики
[router]Стратегия маршрутизации LLM
[self_system]Настройки конвейера самоэволюции
[observability]Метрики, трассировка, логирование
[cron]Конфигурация запланированных задач
[plugins]Пути и настройки WASM-плагинов

Полный список всех доступных параметров — в Полном справочнике конфигурации.

Проверка после настройки

После настройки выполните диагностическую команду для проверки корректности всех параметров:

bash
prx doctor

Проверяются:

  • Файл конфигурации — валидация синтаксиса TOML и обязательных полей
  • Подключение к провайдеру — проверка API-ключа запросом к провайдеру
  • Доступность модели — подтверждение доступности выбранной модели
  • Бэкенд памяти — проверка возможности записи в хранилище
  • Системные зависимости — проверка наличия дополнительных инструментов (git, docker и т.д.)
  • Сеть — проверка подключения к настроенным сервисам

Пример вывода:

PRX Doctor

  Config file .............. OK  (~/.config/openprx/openprx.toml)
  Provider (anthropic) ..... OK  (authenticated)
  Model .................... OK  (claude-sonnet-4-20250514)
  Memory (markdown) ........ OK  (writable)
  Gateway port (3120) ...... OK  (available)
  Git ...................... OK  (2.43.0)
  Docker ................... WARN (not installed -- sandbox features limited)

All critical checks passed.

Подкоманды Doctor

У команды doctor также есть подкоманды для целевой диагностики:

bash
# Опрос каталогов моделей по всем провайдерам
prx doctor models

# Опрос моделей для конкретного провайдера
prx doctor models --provider anthropic

Мастер восстановления каналов

Если вы уже завершили настройку и хотите добавить или исправить конфигурации каналов, используйте флаг --channels-only:

bash
prx onboard --channels-only

Это пропускает настройку провайдера и модели и переходит непосредственно к конфигурации каналов.

Повторный запуск Onboard

Вы можете запустить prx onboard повторно в любое время. Мастер обнаруживает существующую конфигурацию и предлагает обновить её, а не перезаписывать с нуля. Существующие конфигурации каналов, данные памяти и пользовательские настройки сохраняются.

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

Released under the Apache-2.0 License.