README.md

Каталог документации

docs/ — официальный каталог основной документации CodexManager.

Цели:

• хранить руководства по эксплуатации, заметки по релизам и правила сопровождения прямо в репозитории;
• помогать новым участникам быстро находить нужные документы без устной передачи контекста.

Снимок проекта

CodexManager — локальный desktop + service-process менеджер пула аккаунтов и gateway-ретрансляции для сценариев Codex.

• Единое управление аккаунтами, usage и platform key.
• Локальный OpenAI-compatible gateway для Codex CLI, Gemini CLI, Claude Code и сторонних инструментов.
• Поддержка маршрутизации аккаунтов, override профилей моделей и relay через aggregate API.

Последние коммиты

• 524834e: Очистка файлов репозитория.
• 57d85d8: Оптимизированы gateway HTTP bridge и session affinity, усилены keepalive, fallback-повтор без сжатия и bridge-диагностика.
• 43778e4: Улучшена передача prompt_cache_key и ужесточены проверки невалидности аккаунтов.

Обзор возможностей

• Управление пулом аккаунтов: группы, теги, сортировка, заметки, распознавание и фильтрация банов.
• Пакетный импорт/экспорт: мультифайловый импорт, рекурсивный импорт папок в desktop, экспорт по каждому аккаунту.
• Отображение usage: окна 5 часов + 7 дней, single-window аккаунты и дополнительные buckets (Code Review / Spark).
• Platform key: создание, отключение, удаление, привязка модели, reasoning tier и service tier.
• Aggregate API: создание/редактирование/проверка сторонних relay-upstream с поставщиками и приоритетами.
• Plugin center: built-in, private и custom source режимы с задачами/логами и Rhai-интеграцией.
• Локальный service + gateway: настраиваемый bind/listen и единая совместимая точка входа.

Быстрый старт

1. Запустите desktop-приложение и нажмите Start Service.
2. Откройте Account Management и завершите авторизацию аккаунта.
3. Если callback не распарсился автоматически, вставьте callback URL для ручного разбора.
4. Обновите usage и проверьте статус аккаунта.

Скриншоты

Область ответственности

• Корневые README.md / README.en.md: обзор проекта и быстрый старт.
• Корневой Журнал-изменений.md: история версий и невыпущенные изменения.
• report/*: эксплуатация, устранение неполадок, совместимость и FAQ.
• release/*: сборка, упаковка, публикация и описание артефактов.

С чего начать

• Актуальные заметки о релизах и невыпущенных изменениях смотрите в Журнал-изменений.md.
• Если не уверены, какой документ открыть первым, используйте таблицу ниже.

Спонсоры

Спасибо следующим спонсорам за поддержку CodexManager.

	XiaoMo AI Shop (MoDuanXia) предоставляет пользователям CodexManager стабильные сервисы пополнения GPT и Gemini с самостоятельной покупкой и активацией. Зарегистрируйтесь на официальном сайте.
	Xing Si Yan Gateway предоставляет стабильный relay и сопутствующие сервисы для сценариев вызова Claude Code, Codex и похожих моделей. Подходит разработчикам и командам, которым нужны высокодоступные API, удобное подключение и непрерывная поддержка поставки. Актуальные предложения доступны на официальном сайте.

Другие участники поддержки: Wonderdch, suxinwl, Hermit, Suifeng023, HK-hub

Экосистема и связка

OpenCowork

• Репозиторий: AIDotNet/OpenCowork
• Рекомендуемая связка: используйте OpenCowork для локальных файловых операций, multi-agent выполнения, интеграции с рабочими мессенджерами и desktop-автоматизации, а CodexManager оставьте для управления Codex-аккаунтами, учета usage, platform key и локального gateway entry point.
• Лучше всего подходит: командам, которые хотят разделить "рабочее пространство выполнения / офисную интеграцию" и "управление пулом аккаунтов / вход в gateway".
• Коротко: OpenCowork больше про выполнение в рабочей среде, а CodexManager — про управление и gateway.

Быстрая навигация

Что вам нужно сделать	Какой документ открыть
Первый запуск, развёртывание, Docker, первый запуск на macOS	Руководство по запуску и развёртыванию
Переменные среды, база данных, порты, прокси и адрес прослушивания	Переменные среды и конфигурация запуска
Маршрутизация аккаунтов, ошибки импорта и challenge-проверки	FAQ и правила маршрутизации аккаунтов
Почему фоновые задачи пропускают или отключают аккаунты	Пропуск аккаунтов фоновыми задачами
Минимальная интеграция маркетплейса плагинов	Минимальная интеграция центра плагинов
Внутренние команды и точки интеграции	Сводка внутренних интерфейсов системы
Локальная сборка, упаковка и релизные скрипты	Сборка, выпуск и скрипты

Структура каталога

release/

Заметки о релизах, планы отката, описание артефактов и инструкции по упаковке.

report/

Операционные инструкции, заметки по устранению неполадок, отчёты о совместимости и FAQ.

Рекомендуемые документы

Эксплуатация

Документ	Назначение
Руководство по запуску и развёртыванию	Первый запуск десктопа, Service-версия, Docker и первый запуск на macOS
Переменные среды и конфигурация запуска	Параметры запуска, значения по умолчанию и переменные среды
FAQ и правила маршрутизации аккаунтов	Частые проблемы с маршрутизацией аккаунтов и журналами
Сравнение параметров шлюза и Codex	Отличия текущих исходящих параметров от официального Codex
Пропуск аккаунтов фоновыми задачами	Почему фоновые задачи пропускают, охлаждают или отключают аккаунты
Минимальное руководство по устранению неполадок	Быстрые проверки для типовых проблем запуска и релея
Минимальная интеграция центра плагинов	Минимальный набор полей и интерфейсов для маркетплейса плагинов
Различия заголовков и параметров шлюза с Codex	Отличия заголовков и параметров между шлюзом и Codex
Интеграция центра плагинов и интерфейсы	Режимы маркетплейса, RPC/Tauri-команды, поля манифеста и интерфейсы Rhai
Сводка внутренних интерфейсов системы	Внутренние команды, RPC-методы и встроенные функции плагинов

Сборка и релизы

Документ	Назначение
Сборка, выпуск и скрипты	Локальная сборка, параметры скриптов и GitHub workflow
Выпуск и артефакты	Имена артефактов, правила публикации и результаты релиза
Матрица ответственности скриптов и релиза	Какой скрипт или workflow отвечает за какую задачу

Правила по документации

Документацию стоит коммитить, если она

• остаётся полезной для будущих участников,
• влияет на разработку, тестирование, выпуск или диагностику,
• или служит долгосрочным источником истины для проекта.

Документацию не стоит коммитить, если это

• временный черновик,
• личные рабочие заметки,
• одноразовый промежуточный файл,
• или локальная запись эксперимента.

Игнорируемые шаблоны

• docs/**/*.tmp.md
• docs/**/*.local.md

Не используйте эти суффиксы для официальной документации.

Именование

Долгоживущие документы: topic.md
Разовые отчёты: yyyyMMddHHmmssfff_topic.md

Поддержка

• Добавляйте важные материалы в docs/, а не раздувайте README.
• Историю версий ведите в Журнал-изменений.md.
• Архитектурные заметки храните в Архитектура.md.
• Правила совместной работы храните в Руководство-для-участников.md.
• Подробности по невыпущенным изменениям фиксируйте в Журнал-изменений.md, а README оставляйте для навигации.

Контакты

• WeChat: чтобы попасть в группу, добавьте ProsperGao и сразу укажите цель обращения
• Telegram-группа: CodexManager TG group