Перейти к содержимому

Быстрый старт для агентов

Эта страница предназначена для ИИ-агента или пользователя, который работает из терминала через сценарии. Она сосредоточена на командах, кодах выхода и границе между автоматизацией и действиями, для которых требуется согласие пользователя. Если вам нужен сценарий для человека, откройте Быстрый старт. Дашборд остаётся доступен для интерактивной настройки; см. Веб-дашборд.

Установите опубликованный пакет и убедитесь, что ocx доступен в PATH:

Terminal window
npm install -g @bitkyc08/opencodex
ocx --version

Выберите один из способов запуска прокси:

Terminal window
# Foreground: blocks this terminal until stopped.
ocx start
# Background: installs or updates the service, then starts it.
ocx service

Запустите ocx init в интерактивном терминале. Если ocx start уже занимает передний план, используйте второй терминал:

Terminal window
ocx init

Мастер записывает $OPENCODEX_HOME/config.json (обычно ~/.opencodex/config.json). Он также может вставить адрес прокси в config.toml Codex и установить необязательный shim автозапуска Codex. ocx init никогда не запускает прокси. Для полностью неинтерактивной настройки вместо мастера настройте провайдеров через ocx provider add, как показано ниже.

Используйте эти read-only проверки в сценариях и агентных запусках:

Terminal window
ocx status
ocx doctor
ocx health --json

ocx status сообщает состояние прокси и службы. ocx doctor диагностирует локальную среду, сеть, рантайм Codex и проблемы со здоровьем аккаунтов. ocx health завершаетcя с кодом 0, когда прокси исправен, и с 1 в противном случае; --json возвращает структурированный вывод.

Команды, работающие через management API, например ocx combo set, обращаются к живому прокси. Если живой прокси не найден или API недоступен, CLI трактует это как ошибку 503 и завершаетcя с ненулевым кодом. Перед повторной попыткой запустите прокси в foreground или как фоновую службу. Полные поверхности команд и endpoint’ов описаны в справочнике CLI и Management API.

Добавляйте провайдеров и combo без дашборда

Заголовок раздела «Добавляйте провайдеров и combo без дашборда»

Registry-провайдеры можно добавлять по имени. Например, эта команда добавляет пресет Anthropic с API-ключом и делает его провайдером по умолчанию:

Terminal window
ocx provider add anthropic-apikey \
--api-key "$ANTHROPIC_API_KEY" \
--set-default

ocx provider add записывает локальную конфигурацию. Добавьте --sync, если живой прокси уже работает и вы хотите сразу синхронизировать модели в Codex; иначе позже выполните ocx sync. Пользовательские провайдеры, которых нет в registry, требуют одновременно --adapter и --base-url.

Когда все целевые провайдеры настроены и прокси запущен, создайте failover-combo:

Terminal window
ocx combo set main \
--targets anthropic/claude-opus-4-8,openai/gpt-5.6-sol \
--strategy failover

Цели используют синтаксис provider/model и перечисляются через запятую. Результирующая виртуальная модель — combo/main. Подробности о стратегиях, весах, sticky-маршрутизации и поведении при сбоях см. в Combos.

Привязка к loopback по умолчанию не требует API-токена. Для не-loopback-привязки, например 0.0.0.0, требуется OPENCODEX_API_AUTH_TOKEN; без него прокси откажется запускаться. Задайте эту переменную перед ocx start или перед ocx service install, чтобы служба тоже её получила:

Terminal window
export OPENCODEX_API_AUTH_TOKEN="your-secret-token"
ocx service install

После этого клиенты должны аутентифицировать запросы как к management API, так и к модели. Прежде чем открывать opencodex за пределы локальной машины, прочитайте правила удалённого доступа в разделе Конфигурация.