gemini-cli-proxy 1.0.3__tar.gz

gemini_cli_proxy-1.0.3/.cursor/rules/coding-conventions.mdc

@@ -0,0 +1,26 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Coding Conventions
+
+## General conventions
+- **All code comments, docstrings, and error messages must be in English**
+
+## Language
+- Use Python 3.12
+- Use **uv** for package management
+- Follow PEP 8 style guidelines
+
+## Code Style
+- Use **type hints** for all functions
+- Use **async/await** pattern for I/O operations
+- Use structured error responses following **OpenAI format**
+- Log errors with appropriate levels
+
+## Architecture Patterns
+- **OpenAI Compatibility**: Strict adherence to OpenAI API format
+- **Async Execution**: Non-blocking CLI execution with concurrency control
+- **Fake Streaming**: Split complete responses line-by-line for streaming effect
+- **Centralized Configuration**: All config in [src/gemini_cli_proxy/config.py](mdc:src/gemini_cli_proxy/config.py)

gemini_cli_proxy-1.0.3/.cursor/rules/project-overview.mdc

@@ -0,0 +1,35 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Gemini CLI Proxy Project Overview
+
+This is an OpenAI-compatible HTTP API wrapper for Google Gemini CLI tool, enabling seamless integration with OpenAI clients like Cherry Studio.
+
+## Project Structure
+
+The main entry point is [src/gemini_cli_proxy/cli.py](mdc:src/gemini_cli_proxy/cli.py), which handles command-line argument parsing and starts the FastAPI server defined in [src/gemini_cli_proxy/server.py](mdc:src/gemini_cli_proxy/server.py).
+
+### Core Modules
+
+- **CLI Entry**: [src/gemini_cli_proxy/cli.py](mdc:src/gemini_cli_proxy/cli.py) - Command-line interface using Click
+- **FastAPI Server**: [src/gemini_cli_proxy/server.py](mdc:src/gemini_cli_proxy/server.py) - HTTP service with OpenAI-compatible endpoints
+- **Gemini Client**: [src/gemini_cli_proxy/gemini_client.py](mdc:src/gemini_cli_proxy/gemini_client.py) - Async wrapper for Gemini CLI tool
+- **OpenAI Adapter**: [src/gemini_cli_proxy/openai_adapter.py](mdc:src/gemini_cli_proxy/openai_adapter.py) - Format conversion between OpenAI and Gemini
+- **Data Models**: [src/gemini_cli_proxy/models.py](mdc:src/gemini_cli_proxy/models.py) - Pydantic models for request/response validation
+- **Configuration**: [src/gemini_cli_proxy/config.py](mdc:src/gemini_cli_proxy/config.py) - Application configuration management
+
+### Key Files
+
+- **Package Info**: [src/gemini_cli_proxy/__init__.py](mdc:src/gemini_cli_proxy/__init__.py) - Version and package metadata
+- **Project Config**: [pyproject.toml](mdc:pyproject.toml) - Dependencies, build config, and CLI entry point
+- **Documentation**: [README.md](mdc:README.md) - English documentation, [README_zh.md](mdc:README_zh.md) - Chinese documentation
+
+## Key Features
+
+- **OpenAI API Compatibility**: Implements `/v1/chat/completions`, `/v1/models`, and `/health` endpoints
+- **Fake Streaming**: Splits complete Gemini CLI output line-by-line for OpenAI streaming compatibility
+- **Rate Limiting**: 60 requests/minute using SlowAPI
+- **Async Execution**: Non-blocking CLI execution with concurrency control
+- **Modern Distribution**: Installable via `uvx` for zero-config execution

gemini_cli_proxy-1.0.3/.gitignore

@@ -0,0 +1,197 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the enitre vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignoredocs
+
+/local-docs/
+/local-scripts/

gemini_cli_proxy-1.0.3/.python-version

@@ -0,0 +1 @@
+3.12

gemini_cli_proxy-1.0.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 William Liu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gemini_cli_proxy-1.0.3/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: gemini-cli-proxy
+Version: 1.0.3
+Summary: OpenAI-compatible API wrapper for Gemini CLI
+Author: nettee
+License: MIT
+License-File: LICENSE
+Keywords: api,cli,gemini,openai,proxy
+Requires-Python: >=3.8
+Requires-Dist: click<9.0,>=8.0.0
+Requires-Dist: fastapi<1.0,>=0.104.0
+Requires-Dist: pydantic<3.0,>=2.0.0
+Requires-Dist: slowapi<1.0,>=0.1.9
+Requires-Dist: uvicorn[standard]<1.0,>=0.24.0
+Description-Content-Type: text/markdown
+
+# Gemini CLI Proxy
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Wrap Gemini CLI as an OpenAI-compatible API service, allowing you to enjoy the free Gemini 2.5 Pro model through API!
+
+[English](./README.md) | [简体中文](./README_zh.md)
+
+## ✨ Features
+
+- 🔌 **OpenAI API Compatible**: Implements `/v1/chat/completions` endpoint
+- 🚀 **Quick Setup**: Zero-config run with `uvx`
+- ⚡ **High Performance**: Built on FastAPI + asyncio with concurrent request support
+
+## 🚀 Quick Start
+
+### Network Configuration
+
+Since Gemini needs to access Google services, you may need to configure terminal proxy in certain network environments:
+
+```bash
+# Configure proxy (adjust according to your proxy server)
+export https_proxy=http://127.0.0.1:7890
+export http_proxy=http://127.0.0.1:7890  
+export all_proxy=socks5://127.0.0.1:7890
+```
+
+### Install Gemini CLI
+
+Install Gemini CLI:
+```bash
+npm install -g @google/gemini-cli
+```
+
+After installation, use the `gemini` command to run Gemini CLI. You need to start it once first for login and initial configuration.
+
+After configuration is complete, please confirm you can successfully run the following command:
+
+```bash
+gemini -p "Hello, Gemini"
+```
+
+### Start Gemini CLI Proxy
+
+```bash
+uv run gemini-cli-proxy
+```
+
+Gemini CLI Proxy listens on port `8765` by default. You can customize the startup port with the `--port` parameter.
+
+After startup, test the service with curl:
+
+```bash
+curl http://localhost:8765/v1/chat/completions \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer dummy-key" \
+  -d '{
+    "model": "gemini-2.5-pro",
+    "messages": [{"role": "user", "content": "Hello!"}]
+  }'
+```
+
+### Usage Examples
+
+#### OpenAI Client
+
+```python
+from openai import OpenAI
+
+client = OpenAI(
+    base_url='http://localhost:8765/v1',
+    api_key='dummy-key'  # Any string works
+)
+
+response = client.chat.completions.create(
+    model='gemini-2.5-pro',
+    messages=[
+        {'role': 'user', 'content': 'Hello!'}
+    ],
+)
+
+print(response.choices[0].message.content)
+```
+
+#### Cherry Studio
+
+Add Model Provider in Cherry Studio settings:
+- Provider Type: OpenAI
+- API Host: `http://localhost:8765`
+- API Key: Any string works
+- Model Name: `gemini-2.5-pro` or `gemini-2.5-flash`
+
+![Cherry Studio Config 1](./img/cherry-studio-1.jpg)
+
+![Cherry Studio Config 2](./img/cherry-studio-2.jpg)
+
+## ⚙️ Configuration Options
+
+View command line parameters:
+
+```bash
+gemini-cli-proxy --help
+```
+
+Available options:
+- `--host`: Server host address (default: 127.0.0.1)
+- `--port`: Server port (default: 8765)
+- `--log-level`: Log level (debug/info/warning/error/critical)
+- `--rate-limit`: Max requests per minute (default: 60)
+- `--max-concurrency`: Max concurrent subprocesses (default: 4)
+- `--timeout`: Gemini CLI command timeout in seconds (default: 30.0)
+- `--debug`: Enable debug mode
+
+## ❓ FAQ
+
+### Q: Why do requests keep timing out?
+
+A: This is usually a network connectivity issue. Gemini needs to access Google services, which may require proxy configuration in certain regions:
+
+```bash
+# Configure proxy (adjust according to your proxy server)
+export https_proxy=http://127.0.0.1:7890
+export http_proxy=http://127.0.0.1:7890
+export all_proxy=socks5://127.0.0.1:7890
+
+# Then start the service
+uvx gemini-cli-proxy
+```
+
+## 📄 License
+
+MIT License
+
+## 🤝 Contributing
+
+Issues and Pull Requests are welcome! 

gemini_cli_proxy-1.0.3/README.md

@@ -0,0 +1,137 @@
+# Gemini CLI Proxy
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Wrap Gemini CLI as an OpenAI-compatible API service, allowing you to enjoy the free Gemini 2.5 Pro model through API!
+
+[English](./README.md) | [简体中文](./README_zh.md)
+
+## ✨ Features
+
+- 🔌 **OpenAI API Compatible**: Implements `/v1/chat/completions` endpoint
+- 🚀 **Quick Setup**: Zero-config run with `uvx`
+- ⚡ **High Performance**: Built on FastAPI + asyncio with concurrent request support
+
+## 🚀 Quick Start
+
+### Network Configuration
+
+Since Gemini needs to access Google services, you may need to configure terminal proxy in certain network environments:
+
+```bash
+# Configure proxy (adjust according to your proxy server)
+export https_proxy=http://127.0.0.1:7890
+export http_proxy=http://127.0.0.1:7890  
+export all_proxy=socks5://127.0.0.1:7890
+```
+
+### Install Gemini CLI
+
+Install Gemini CLI:
+```bash
+npm install -g @google/gemini-cli
+```
+
+After installation, use the `gemini` command to run Gemini CLI. You need to start it once first for login and initial configuration.
+
+After configuration is complete, please confirm you can successfully run the following command:
+
+```bash
+gemini -p "Hello, Gemini"
+```
+
+### Start Gemini CLI Proxy
+
+```bash
+uv run gemini-cli-proxy
+```
+
+Gemini CLI Proxy listens on port `8765` by default. You can customize the startup port with the `--port` parameter.
+
+After startup, test the service with curl:
+
+```bash
+curl http://localhost:8765/v1/chat/completions \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer dummy-key" \
+  -d '{
+    "model": "gemini-2.5-pro",
+    "messages": [{"role": "user", "content": "Hello!"}]
+  }'
+```
+
+### Usage Examples
+
+#### OpenAI Client
+
+```python
+from openai import OpenAI
+
+client = OpenAI(
+    base_url='http://localhost:8765/v1',
+    api_key='dummy-key'  # Any string works
+)
+
+response = client.chat.completions.create(
+    model='gemini-2.5-pro',
+    messages=[
+        {'role': 'user', 'content': 'Hello!'}
+    ],
+)
+
+print(response.choices[0].message.content)
+```
+
+#### Cherry Studio
+
+Add Model Provider in Cherry Studio settings:
+- Provider Type: OpenAI
+- API Host: `http://localhost:8765`
+- API Key: Any string works
+- Model Name: `gemini-2.5-pro` or `gemini-2.5-flash`
+
+![Cherry Studio Config 1](./img/cherry-studio-1.jpg)
+
+![Cherry Studio Config 2](./img/cherry-studio-2.jpg)
+
+## ⚙️ Configuration Options
+
+View command line parameters:
+
+```bash
+gemini-cli-proxy --help
+```
+
+Available options:
+- `--host`: Server host address (default: 127.0.0.1)
+- `--port`: Server port (default: 8765)
+- `--log-level`: Log level (debug/info/warning/error/critical)
+- `--rate-limit`: Max requests per minute (default: 60)
+- `--max-concurrency`: Max concurrent subprocesses (default: 4)
+- `--timeout`: Gemini CLI command timeout in seconds (default: 30.0)
+- `--debug`: Enable debug mode
+
+## ❓ FAQ
+
+### Q: Why do requests keep timing out?
+
+A: This is usually a network connectivity issue. Gemini needs to access Google services, which may require proxy configuration in certain regions:
+
+```bash
+# Configure proxy (adjust according to your proxy server)
+export https_proxy=http://127.0.0.1:7890
+export http_proxy=http://127.0.0.1:7890
+export all_proxy=socks5://127.0.0.1:7890
+
+# Then start the service
+uvx gemini-cli-proxy
+```
+
+## 📄 License
+
+MIT License
+
+## 🤝 Contributing
+
+Issues and Pull Requests are welcome!