This commit is contained in:
73
docs/misc/cli-proxy-api.md
Normal file
73
docs/misc/cli-proxy-api.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# CLI Proxy API
|
||||
|
||||
[CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) - прокси для доступа к Codex и другим CLI-моделям через OpenAI-совместимый API. Можно подключать к Cursor и другим клиентам.
|
||||
|
||||
|
||||
## Установка
|
||||
|
||||
На сервере должны быть установлены Docker и Docker Compose plugin. Порт `8317/tcp` должен быть открыт.
|
||||
|
||||
```sh
|
||||
git clone https://github.com/router-for-me/CLIProxyAPI.git
|
||||
cd CLIProxyAPI
|
||||
cp config.example.yaml config.yaml
|
||||
```
|
||||
|
||||
Для удалённого доступа к Web UI и статистики использования добавляем в `config.yaml`:
|
||||
|
||||
=== "Терминал"
|
||||
|
||||
```sh
|
||||
nano config.yaml
|
||||
```
|
||||
|
||||
=== "config.yaml"
|
||||
|
||||
```yaml
|
||||
remote-management:
|
||||
allow-remote: true
|
||||
secret-key: "your-very-long-secret"
|
||||
disable-control-panel: false
|
||||
|
||||
usage-statistics-enabled: true
|
||||
```
|
||||
|
||||
Запускаем контейнер.
|
||||
|
||||
```sh
|
||||
docker compose up -d
|
||||
docker compose logs -f
|
||||
```
|
||||
|
||||
## OAuth-логин Codex
|
||||
|
||||
Логин выполняется на удалённом сервере, но браузер открывается локально - для этого пробрасываем порт через SSH.
|
||||
|
||||
```sh
|
||||
ssh -L 1455:localhost:1455 <user>@<server>
|
||||
|
||||
cd ~/CLIProxyAPI
|
||||
docker compose exec cli-proxy-api /CLIProxyAPI/CLIProxyAPI -no-browser --codex-login
|
||||
```
|
||||
|
||||
## Проверка
|
||||
|
||||
Список доступных моделей:
|
||||
|
||||
```sh
|
||||
curl http://<IP>:8317/v1/models \
|
||||
-H "Authorization: Bearer your-api-key-1"
|
||||
```
|
||||
|
||||
Web UI управления: `http://<IP>:8317/management.html`
|
||||
|
||||
## Подключение Cursor
|
||||
|
||||
В настройках Cursor (`ctrl + shift + j`) → **Models** → **API Keys** → **OpenAPI** указываем:
|
||||
|
||||
- **API Key** - ключ из конфига
|
||||
- **Base URL** - `http://<IP>:8317/v1`
|
||||
|
||||
## Полезные ссылки
|
||||
|
||||
- [Codex usage и лимиты](https://chatgpt.com/codex/settings/usage) - встроенная статистика использования
|
||||
Reference in New Issue
Block a user