Zero: Подробное объяснение конфигурации
В этой статье представлено подробное объяснение элементов конфигурации в файле конфигурации CLIProxyAPI проекта, к которому пользователи могут обращаться при возникновении вопросов.
Дружеское напоминание: файл конфигурации поддерживает hot-reloading. Изменения в файле конфигурации вступают в силу немедленно без перезапуска программы.
# Номер порта, CLIProxyAPI запускает HTTP-сервер и требует номер порта для доступа
port: 8317
# Конфигурация удаленного управления, используется с EasyCLI или WebUI
remote-management:
# Переключатель для включения удаленного управления. Если вы развертываете его на сервере,
# вам нужно установить значение true, чтобы использовать EasyCLI или WebUI для подключения к CLIProxyAPI
# для управления.
# Если вы используете API только для локального управления, вы можете оставить значение false.
allow-remote: false
# Если вы хотите использовать EasyCLI или WebUI для управления CLIProxyAPI через API,
# вы должны установить Key.
# Если он не установлен, считается, что функция управления API
# отключена, и вы не сможете использовать EasyCLI или WebUI для подключения.
# Если вам не нужно использовать EasyCLI или WebUI для управления, вы можете оставить его
# пустым.
secret-key: ""
# Переключатель для интеграции WebUI.
# Установите значение false, вы сможете открыть WebUI через
# http://YOUR_SERVER_IP:8317/management.html
disable-control-panel: false
# Директория для хранения файлов аутентификации, используемая для хранения файлов аутентификации
# для Gemini CLI, Gemini Web, Qwen Code и Codex.
# По умолчанию это папка .cli-proxy-api в директории вашей текущей учетной записи,
# что совместимо с окружениями Windows и Linux.
# Программа автоматически создаст эту папку при первом
# запуске.
# В Windows по умолчанию это C:\Users\имя_пользователя\.cli-proxy-api
# В Linux по умолчанию это /home/имя_пользователя/.cli-proxy-api
# Если вы используете нестандартное расположение в окружении Windows, вам нужно
# изменить его в формате "Z:\\CLIProxyAPI\\auths"
auth-dir: "~/.cli-proxy-api"
# Включать ли Debug-информацию в лог, по умолчанию отключено.
# Вам нужно включать это только тогда, когда автору требуется помощь в
# устранении неполадок.
debug: false
# Скрытая конфигурация, которая может записывать каждый запрос и ответ и сохранять их
# в директорию logs.
# Размер каждого лога может достигать 10MB+. Пожалуйста, не включайте это, если ваш
# жесткий диск недостаточно велик.
request-log: false
# Перенаправлять ли лог в файл лога.
# Включено по умолчанию, и лог будет сохранен в папке logs в
# директории программы.
# Если отключено, лог будет отображаться в консоли.
logging-to-file: true
# Переключатель для статистики использования, включен по умолчанию.
# Вам нужно использовать API для просмотра использования, вы можете использовать EasyCLI или WebUI для
# его просмотра.
usage-statistics-enabled: true
# Если вы хотите использовать прокси, вам нужно задать следующие настройки, которые
# поддерживают протоколы socks5/http/https.
# Заполните в соответствии с форматом "socks5://user:[email protected]:1080/"
proxy-url: ""
# Количество попыток, которые программа автоматически предпринимает при
# возникновении кодов ошибок, таких как 403, 408, 500, 502, 503, 504.
request-retry: 3
# Поведение после ограничения модели.
quota-exceeded:
# Основная конфигурация опроса нескольких аккаунтов.
# Когда установлено значение true, например, если аккаунт вызывает 429, программа
# автоматически переключится на следующий аккаунт для повторного инициирования запроса.
# Когда установлено значение false, программа отправит сообщение об ошибке 429
# клиенту и завершит текущий запрос.
# То есть, когда установлено значение true, пока хотя бы один из
# опрашиваемых аккаунтов в норме, клиент не сообщит об ошибке.
# Когда установлено значение false, клиенту необходимо повторить попытку или прервать операцию.
switch-project: true
# Эксклюзивная конфигурация Gemini CLI, применимая к моделям Gemini 2.5 Pro и
# Gemini 2.5 Flash.
# Когда квота официальной версии исчерпана, она автоматически переключится на
# модель Preview. Просто держите её включенной.
switch-preview-model: true
# Скрытая конфигурация, вы можете отключить интервал времени во время повторных попыток и
# настроить его по мере необходимости.
# Например, после того как модель вызывает 429, программа временно отключит
# её, и каждый раз, когда она вызывается снова, время деактивации будет
# увеличиваться, максимум до 30 минут.
# По умолчанию модель будет пропускаться в период деактивации.
# После установки значения true запрос все равно будет отправляться модели каждый
# раз, независимо от того, находится ли модель в периоде деактивации, и она
# больше не будет пропускаться.
disable-cooling: false
# Ключи, необходимые различным AI-клиентам для доступа к CLIProxyAPI, устанавливаются здесь.
# Не путайте их с различными ключами ниже.
# Простыми словами, Key здесь — это то, что CLIProxyAPI нужно установить как
# сервер.
# Различные ключи ниже — это то, что нужно CLIProxyAPI как клиенту для доступа к
# серверу.
api-keys:
- "your-api-key-1"
- "your-api-key-2"
# Переключатель аутентификации AIStudio. Когда установлено значение true, вышеуказанные api-keys будут
# использоваться для аутентификации доступа AIStudio Build APP.
ws-auth: false
# Конфигурация Gemini API key. Устаревшие значения `generative-language-api-key` автоматически переносятся сюда и удаляются из файла конфигурации при сохранении.
# Когда base-url не установлен, для доступа используется официальный эндпоинт. Когда
# base-url установлен, можно получить доступ к стороннему релею.
# При доступе через Cloudflare AI Gateway аутентификация может быть выполнена
# путем установки headers.
# Для каждого Key вы также можете установить proxy-url для подключения через прокси.
gemini-api-key:
- api-key: "AIzaSy...01"
base-url: "https://generativelanguage.googleapis.com"
headers:
X-Custom-Header: "custom-value"
proxy-url: "socks5://proxy.example.com:1080"
- api-key: "AIzaSy...02"
# API Key для Codex. Здесь можно заполнить параметры api-key и base-url для Codex, предоставляемые
# различными релей-станциями, для доступа.
# Для каждого Key вы также можете установить proxy-url для подключения через прокси.
codex-api-key:
- api-key: "sk-atSM..."
base-url: "https://www.example.com"
proxy-url: "socks5://proxy.example.com:1080"
# API Key для Claude. При использовании официального Key не заполняйте base-url. Для
# сторонних релеев заполните base-url.
# Для каждого Key вы также можете установить proxy-url для подключения через прокси.
claude-api-key:
- api-key: "sk-atSM..."
- api-key: "sk-atSM..."
base-url: "https://www.example.com"
proxy-url: "socks5://proxy.example.com:1080"
models:
# Имя модели, предоставленное провайдером релея
- name: "claude-3-5-sonnet-20241022"
# Алиас модели, который является именем модели, фактически установленным в клиенте
alias: "claude-sonnet-latest"
# Все OpenAI-совместимые сервисы могут быть доступны здесь, без лишних объяснений.
openai-compatibility:
- name: "openrouter"
base-url: "https://openrouter.ai/api/v1"
# Устаревшие api-keys переносятся в api-key-entries при загрузке.
api-key-entries:
- api-key: "sk-or-v1-...b780"
proxy-url: "socks5://proxy.example.com:1080"
- api-key: "sk-or-v1-...b781"
models:
# Имя модели, предоставленное OpenAI-совместимым провайдером
- name: "moonshotai/kimi-k2:free"
# Алиас модели, который является именем модели, фактически установленным в клиенте
alias: "kimi-k2"