Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
- Keep Windows PowerShell 5.1 compatibility and macOS system Bash compatibility.
- Validate script syntax, generated TOML/JSON, idempotency, secret handling, and uninstall boundaries before publishing.

- Codex uses the user-level profile-v2 file and `/v1/codex` with WebSocket enabled. Publish installers only after authenticated server catalog and HTTP/WebSocket release checks; HTTP fallback keeps the same profile URL.
- Codex CLI uses a user-level profile-v2 file, `https://codex.neuroapi.host/v1`, and WebSocket by default; the optional Codex Desktop setup uses the same host with HTTP/SSE. Publish installers only after authenticated catalog and transport checks.
- Keep unsupported hosted Codex tools (`web_search`, multi-agent namespace, goals, apps and browser use) disabled in this profile until the server can execute and bill them safely; local file and shell tools must remain available.
- Managed launchers fetch and validate fresh key-scoped catalogs into private per-launch snapshots; never fall back to stale/bundled lists or accept executable server settings. Claude's explicit base URL is `/v1/claude-code`. Keep ordinary keys, preserve unrelated configuration, and document managed-policy/explicit-override boundaries.
- Managed launchers fetch and validate fresh key-scoped catalogs into private per-launch snapshots; never fall back to stale/bundled lists or accept executable server settings. Claude Code's base URL is `https://claude.neuroapi.host`; Claude Desktop gateway is configured separately in its UI. Keep ordinary keys, preserve unrelated configuration, and document managed-policy/explicit-override boundaries.
7 changes: 5 additions & 2 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Public, auditable guided setup for routing local Codex CLI and Claude Code sessi

## Release compatibility

This version configures `https://codex.neuroapi.host/v1` with `supports_websockets = true`, and `https://claude.neuroapi.host` for Claude Code. The Codex profile disables hosted web search, multi-agent, goals, apps, and browser use because the current client includes these tools even in simple local tasks, while NeuroAPI does not guarantee their upstream execution. Local shell and file tools remain available. Setup checks both key-scoped catalogs without a paid generation. Verify HTTP/WebSocket Responses and Claude Messages/count_tokens after each server release.
This version configures `https://codex.neuroapi.host/v1` with `supports_websockets = true`, and `https://claude.neuroapi.host` for Claude Code. The Codex profile disables hosted web search, multi-agent, goals, apps, and browser use because the current client includes these tools even in simple local tasks, while NeuroAPI does not guarantee their upstream execution. Local shell and file tools remain available. Setup checks both key-scoped catalogs without a paid generation. After setup, send one short real request and confirm it in your [NeuroAPI usage log](https://neuroapi.host/dashboard/logs); a catalog check alone does not prove generation works.

An existing `CODEX_HOME` selects the profile directory without being modified. Keep its value consistent for setup, launch and uninstall.

Expand Down Expand Up @@ -36,6 +36,8 @@ macOS:

The setup does not require administrator privileges or `sudo`. Codex Desktop integration edits the user config only after consent, with a guarded backup and conflict checks.

Claude Desktop is configured separately in the app's official Developer Mode → Configure Third-Party Inference screen. The installer does not silently change the app's private settings; follow the [Claude Desktop guide](https://neuroapi.host/docs/claude-desktop). If an older connection failed, follow the [reconnection guide](docs/reconnect-after-update.md) before retrying.

## Secret model

- The key is never accepted as a setup command-line argument.
Expand Down Expand Up @@ -64,9 +66,10 @@ Claude Code also uses the `haiku` alias for background work. If no recommended H

- [Security model](docs/security.md)
- [Manual setup and installed paths](docs/manual-setup.md)
- [Reconnect after an older failed setup](docs/reconnect-after-update.md)
- [Troubleshooting](docs/troubleshooting.md)
- [Codex guide](https://neuroapi.host/codex-api)
- [Claude Code guide](https://neuroapi.host/claude-code)
- [Codex Desktop guide](https://neuroapi.host/docs/codex-desktop)
- [Claude Desktop Code guide](https://neuroapi.host/docs/claude-desktop)
- [Claude Desktop guide](https://neuroapi.host/docs/claude-desktop)
- [NeuroAPI documentation](https://neuroapi.host/docs/getting-started)
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ NeuroAPI — российский AI API-сервис: единый доступ

## Совместимость версии

Эта версия создаёт профиль Codex с `https://codex.neuroapi.host/v1` и `supports_websockets = true`, а профиль Claude Code — с `https://claude.neuroapi.host`. Codex-профиль отключает hosted web search, multi-agent, goals, apps и browser use: эти инструменты новейший клиент отправляет даже в простых задачах, а NeuroAPI пока не гарантирует их провайдерское исполнение. Локальные команды, чтение и редактирование файлов работают. Установщик проверяет доступ ключа к обоим каталогам без платной генерации. Генерацию через HTTP/WebSocket Responses и Claude Messages/count_tokens проверяйте после серверного релиза.
Эта версия создаёт профиль Codex с `https://codex.neuroapi.host/v1` и `supports_websockets = true`, а профиль Claude Code — с `https://claude.neuroapi.host`. Codex-профиль отключает hosted web search, multi-agent, goals, apps и browser use: эти инструменты новейший клиент отправляет даже в простых задачах, а NeuroAPI пока не гарантирует их провайдерское исполнение. Локальные команды, чтение и редактирование файлов работают. Установщик проверяет доступ ключа к обоим каталогам без платной генерации. После установки отправьте короткий реальный запрос и проверьте его в [истории использования NeuroAPI](https://neuroapi.host/dashboard/logs): проверка каталога сама по себе не подтверждает генерацию.

Уже заданный `CODEX_HOME` учитывается для профиля и не изменяется; сохраняйте одинаковое значение при установке, запуске и удалении.

Expand Down Expand Up @@ -62,6 +62,10 @@ bash setup-macos.command

Скрипт не использует `sudo` и не редактирует shell profile. Если `~/.local/bin` уже входит в `PATH`, достаточно команд `codex-neuroapi` и `claude-neuroapi`.

**Claude Desktop устанавливается отдельно.** Установщик не меняет закрытые настройки приложения: включите Developer Mode и укажите NeuroAPI в штатной форме Configure Third-Party Inference по [инструкции для Claude Desktop](https://neuroapi.host/docs/claude-desktop). Для Codex Desktop при установке ответьте «да» на отдельный вопрос, затем перезапустите приложение и создайте новую локальную задачу.

Если вы уже пробовали подключиться и получали ошибки, сначала пройдите [восстановление старой настройки](docs/reconnect-after-update.md). Оно сохраняет ваши проекты и помогает найти старый URL, профиль или источник ключа.

## Что именно делает установщик

| Действие | Windows | macOS |
Expand Down Expand Up @@ -138,11 +142,12 @@ Uninstaller удаляет только installer-owned файлы и локал

- [Модель безопасности](docs/security.md)
- [Ручная настройка и созданные файлы](docs/manual-setup.md)
- [Как переподключиться после неудачной старой настройки](docs/reconnect-after-update.md)
- [Решение проблем](docs/troubleshooting.md)
- [Codex через NeuroAPI](https://neuroapi.host/codex-api)
- [Claude Code через NeuroAPI](https://neuroapi.host/claude-code)
- [Codex Desktop](https://neuroapi.host/docs/codex-desktop)
- [Claude Desktop Code](https://neuroapi.host/docs/claude-desktop)
- [Claude Desktop](https://neuroapi.host/docs/claude-desktop)
- [OpenAI-совместимый API](https://neuroapi.host/openai-compatible-api)
- [Модели и цены](https://neuroapi.host/price)

Expand Down
75 changes: 73 additions & 2 deletions docs/manual-setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,77 @@
# Что настраивают установщики

Эта страница нужна для аудита и ручного восстановления. Рекомендуемый путь — root setup-файл для вашей ОС.
Эта страница объясняет как выполнить настройку вручную и какие файлы создаёт автоматический установщик. Самый простой путь — [setup-файл для вашей ОС](../README.md#установка-в-один-запуск). Если старая настройка уже не работала, начните с [пошагового восстановления](reconnect-after-update.md).

## Адреса и ключ

Используйте обычный API-ключ из [кабинета NeuroAPI](https://neuroapi.host/login?redirect=/dashboard/tokens). Скопируйте его целиком, включая префикс `sk-`; не добавляйте `Bearer ` в поле ключа. Отдельный ключ для Codex и Claude не нужен; доступные модели зависят от ключа, тарифа и текущих маршрутов.

| Клиент | Базовый адрес |
|---|---|
| Codex CLI и Codex Desktop (Responses API) | `https://codex.neuroapi.host/v1` |
| Claude Code и Claude Desktop (Anthropic API) | `https://claude.neuroapi.host` |
| Другие OpenAI-совместимые приложения | `https://neuroapi.host/v1` |

Не добавляйте `/responses` к базовому адресу Codex или `/v1/messages` к базовому адресу Claude: клиенты добавляют путь запроса сами. Уточните точный ID модели в [каталоге](https://neuroapi.host/price); название в старой сохранённой сессии может устареть.

## Вручную без установщика: временный ключ в терминале

Ниже приведён способ проверить подключение без изменения постоянных настроек ОС. Переменная среды доступна только этому терминалу и запущенным из него программам; не записывайте ключ в TOML, JSON, shell profile или историю команд. После закрытия терминала ввод потребуется повторить. Для постоянной настройки с защищённым хранением ключа используйте установщик или собственный credential helper.

macOS (Terminal):

```bash
printf 'Вставьте ключ NeuroAPI и нажмите Enter: '
read -r -s NEUROAPI_API_KEY
printf '\n'
export NEUROAPI_API_KEY
```

Windows (PowerShell):

```powershell
$secure = Read-Host 'Ключ NeuroAPI' -AsSecureString
$ptr = [Runtime.InteropServices.Marshal]::SecureStringToBSTR($secure)
try { $env:NEUROAPI_API_KEY = [Runtime.InteropServices.Marshal]::PtrToStringBSTR($ptr) }
finally { [Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ptr) }
Remove-Variable secure, ptr
```

Для Codex создайте файл `~/.codex/neuroapi-manual.config.toml` (Windows: `%USERPROFILE%\.codex\neuroapi-manual.config.toml`):

```toml
model = "gpt-6-sol" # замените на модель, доступную вашему ключу
model_provider = "neuroapi_manual"
web_search = "disabled"

[features]
multi_agent = false
goals = false
apps = false
browser_use = false

[model_providers.neuroapi_manual]
name = "NeuroAPI"
base_url = "https://codex.neuroapi.host/v1"
wire_api = "responses"
supports_websockets = true
env_key = "NEUROAPI_API_KEY"
```

Запустите `codex --profile neuroapi-manual`, проверьте `/debug-config` и выполните короткую задачу. Этот ручной профиль не получает управляемый каталог: встроенное меню Codex может содержать недоступные модели. Выбирайте проверенный ID явно. Файл профиля должен находиться в том же `CODEX_HOME`, с которым вы запускаете Codex; проектный `.codex/config.toml` не заменяет его.

Для Claude Code в том же терминале задайте адрес и модель, затем запустите `claude`:

```bash
export ANTHROPIC_API_KEY="$NEUROAPI_API_KEY"
export ANTHROPIC_BASE_URL="https://claude.neuroapi.host"
export ANTHROPIC_MODEL="claude-sonnet-5-5" # замените на доступную модель
claude
```

В PowerShell эквивалентные команды — `$env:ANTHROPIC_API_KEY = $env:NEUROAPI_API_KEY`, `$env:ANTHROPIC_BASE_URL = 'https://claude.neuroapi.host'`, `$env:ANTHROPIC_MODEL = 'claude-sonnet-5-5'`, затем `claude`. Проверьте `/status` и `/model`. Старые `ANTHROPIC_AUTH_TOKEN`, Bedrock/Vertex/Foundry overrides и пользовательские settings могут иметь иной приоритет; [порядок восстановления](reconnect-after-update.md) помогает найти конфликт. При выходе из тестового терминала удалите временный ключ (`unset NEUROAPI_API_KEY ANTHROPIC_API_KEY` на macOS; `Remove-Item Env:NEUROAPI_API_KEY, Env:ANTHROPIC_API_KEY` в PowerShell) или просто закройте окно.

Codex Desktop не наследует переменную из терминала при обычном запуске через GUI. Для него выбирайте опцию в установщике либо [ручную настройку Desktop](https://neuroapi.host/docs/codex-desktop). Claude Desktop настраивается только в [официальной форме приложения](https://neuroapi.host/docs/claude-desktop).

## Codex CLI

Expand Down Expand Up @@ -55,7 +126,7 @@ Project `.codex/config.toml` не подходит для provider/auth redirect

Если соединение WebSocket блокируется вашей сетью, в секции `[model_providers.neuroapi]` созданного профиля замените `supports_websockets = true` на `supports_websockets = false`. Base URL остаётся `https://codex.neuroapi.host/v1`, auth helper и key storage не меняются. При повторном запуске setup управляемый профиль снова получит настройку по умолчанию `true`.

Если сервер ещё не предоставляет `https://codex.neuroapi.host/v1/models` и `/v1/responses` на том же субдомене, не распространяйте эту версию установщика: сначала требуется согласованный серверный выпуск. Общий `/v1` возвращает другой формат каталога при command-backed auth.
Если `https://codex.neuroapi.host/v1/models` или `/v1/responses` недоступны, проверьте DNS, сеть, ключ и [доступность сайта](https://neuroapi.host); локальное изменение `supports_websockets` не исправит ошибку `404` на endpoint. Общий `/v1` использует иной каталог и не заменяет выделенный адрес Codex для управляемого профиля.

## Claude Code

Expand Down
Loading
Loading