Интеграция для разработчиков

    Как подключить Codex CLI к NeuroAPI

    Воспроизводимая настройка локального Codex CLI через custom provider NeuroAPI — с безопасным хранением ключа и явной проверкой Responses-совместимости.

    Короткий ответ

    Краткий ответ

    Подключение Codex CLI к NeuroAPI через открытый установщик для Windows и macOS: защищённое хранение ключа, отдельный профиль, Responses API и проверка /debug-config.

    Локальный Codex CLI

    Инструкция относится к терминальному Codex CLI с пользовательским файлом конфигурации.

    Responses API

    Codex поддерживает для custom provider только wire_api = "responses".

    Открытый установщик

    BAT и macOS-скрипт опубликованы на GitHub: действия можно проверить до запуска.

    Модель из каталога

    В примере указан gpt-5.6-sol; перед запуском проверьте его доступность и точный ID.

    Что потребуется

    Установите актуальный Codex CLI, создайте ключ NeuroAPI и убедитесь, что выбранная модель опубликована в каталоге. Для Codex нужен маршрут OpenAI Responses, а не только Chat Completions.

    Пример ниже использует gpt-5.6-sol. Если модель недоступна в вашем тарифе или каталоге, замените значение model на опубликованный ID модели с совместимыми инструментами и Responses API.

    • Codex CLI, запущенный локально из терминала.
    • Ключ NeuroAPI с достаточным лимитом.
    • Опубликованная модель, подходящая для программирования и tool calls.
    • Доступ к POST /v1/responses через https://neuroapi.host/v1.

    Рекомендуемый способ: открытый установщик

    Скачайте публичный репозиторий neurogen-dev/NeuroAPI, откройте исходники и запустите setup-windows.bat либо setup-macos.command. Установщик сам попросит API-ключ в терминале; ключ не передаётся аргументом команды и не записывается в Git или обычный TOML.

    На Windows секрет сохраняется в зашифрованном DPAPI-файле текущего пользователя, на macOS — в login Keychain. Codex получает токен через официальный command-backed auth helper.

    • Существующий ~/.codex/config.toml не перезаписывается.
    • Создаётся отдельный профиль ~/.codex/neuroapi-host.config.toml.
    • Повторный запуск обновляет только файлы, принадлежащие установщику.
    • Исходный код, модель угроз и удаление опубликованы в том же репозитории.

    Ручная настройка как запасной вариант

    Без установщика добавьте provider в пользовательский ~/.codex/config.toml или в отдельный user-profile. Проектный .codex/config.toml поддерживает обычные настройки, но актуальный Codex намеренно игнорирует там model_provider, model_providers и credential-routing keys.

    Для краткого теста можно передать ключ через NEUROAPI_API_KEY только в текущую сессию терминала. Не сохраняйте секрет в репозитории, общем project config или примере для команды.

    • model_provider должен совпадать с ID секции model_providers.neuroapi.
    • base_url заканчивается на /v1.
    • env_key содержит имя переменной, а не сам секрет.
    • В текущей документации Codex wire_api принимает responses.

    Проверьте фактическую конфигурацию

    В запущенном Codex выполните /debug-config и проверьте, что выбран provider neuroapi и пользовательский config.toml. После этого отправьте небольшой запрос на анализ проекта.

    Если клиент сообщает о неподдерживаемом endpoint или формате, сначала проверьте wire_api, наличие /v1 в base_url и совместимость выбранной модели с Responses API.

    • 401 — повторно сохраните ключ установщиком либо проверьте временную NEUROAPI_API_KEY.
    • Model not found — возьмите точный ID из текущего каталога.
    • Responses error — проверьте модель и документацию POST /v1/responses.
    • Старый конфиг — обновите Codex CLI и повторите /debug-config.

    Граница этой интеграции

    Custom model providers — функция локальных клиентов Codex. Эта инструкция не обещает, что тот же provider автоматически применяется к Codex cloud, ChatGPT или другим размещённым OpenAI-поверхностям.

    NeuroAPI выдаёт собственный ключ доступа. Это не официальный API-ключ OpenAI и не подписка ChatGPT.

    Windows: скачать и запустить

    PowerShell
    git clone --branch agents https://github.com/neurogen-dev/NeuroAPI.git
    Set-Location .\NeuroAPI
    .\setup-windows.bat

    macOS: скачать и запустить

    Shell
    git clone --branch agents https://github.com/neurogen-dev/NeuroAPI.git
    cd NeuroAPI
    ./setup-macos.command

    Пользовательский ~/.codex/config.toml

    TOML
    model = "gpt-5.6-sol"
    model_provider = "neuroapi"
    
    [model_providers.neuroapi]
    name = "NeuroAPI"
    base_url = "https://neuroapi.host/v1"
    env_key = "NEUROAPI_API_KEY"
    wire_api = "responses"

    Запуск из PowerShell

    PowerShell
    $env:NEUROAPI_API_KEY = "<NEUROAPI_API_KEY>"
    Set-Location "C:\path\to\project"
    codex

    Запуск из Bash или Zsh

    Shell
    export NEUROAPI_API_KEY="<NEUROAPI_API_KEY>"
    cd /path/to/project
    codex