From 0dbae81353c162b0b95d566493164ea6c02e2fa2 Mon Sep 17 00:00:00 2001 From: Gemini Nexus Bot Date: Sat, 2 May 2026 02:46:14 -0300 Subject: [PATCH] docs: refine READMEs and highlight Windows SmartScreen warning - Move Windows SmartScreen workaround instructions to a highly visible warning block at the top of the files - Add SmartScreen instructions to the Installation / Downloads sections - Standardize headings, hierarchy, and formatting across all 4 languages (EN, PT-BR, ES, ZH-CN) - Polish text for better flow and clarity in 'Why Gemini Nexus?' and Tech Stack sections --- README.es.md | 172 ++++++++++++++++++++++++++++++++------------- README.md | 142 +++++++++++++++++++++----------------- README.pt-BR.md | 132 +++++++++++++++++++---------------- README.zh-CN.md | 180 ++++++++++++++++++++++++++++++++++++------------ 4 files changed, 412 insertions(+), 214 deletions(-) diff --git a/README.es.md b/README.es.md index 296d51d..2ff59ae 100644 --- a/README.es.md +++ b/README.es.md @@ -23,27 +23,48 @@ Licencia Plataforma + Electron

+> [!IMPORTANT] +> **Usuarios de Windows:** Si ves una advertencia de SmartScreen **"Windows protegió su PC"** durante la instalación, haz clic en **"Más información"** y luego en **"Ejecutar de todas formas"**. Esta es una advertencia de seguridad esperada para aplicaciones nuevas no firmadas. + +--- + +## 📖 Tabla de Contenidos + +- [✨ ¿Por qué Gemini Nexus?](#-por-qué-gemini-nexus) +- [🎯 Características](#-características) +- [📸 Capturas de Pantalla](#-capturas-de-pantalla) +- [⚡ Instalación e Inicio Rápido](#-instalación-e-inicio-rápido) +- [🛠️ Stack Tecnológico](#️-stack-tecnológico) +- [💻 Desarrollo](#-desarrollo) +- [❓ Preguntas Frecuentes](#-preguntas-frecuentes) +- [🤝 Contribuir](#-contribuir) +- [📄 Licencia](#-licencia) + --- ## ✨ ¿Por qué Gemini Nexus? Al usar IDEs y herramientas de programación con IA, ¿te has encontrado con estos problemas? -- 😫 La cuota de una sola cuenta se agota rápido, requiriendo cambios manuales frecuentes -- 🔄 Gestionar múltiples cuentas de Google/Claude es tedioso -- 📊 No sabes cuántos tokens has consumido o cuánta cuota queda -- 🔌 Necesitas un proxy local confiable que hable los protocolos OpenAI/Anthropic +- 😫 **Límites de cuota:** La cuota de una sola cuenta se agota rápido, requiriendo cambios manuales frecuentes. +- 🔄 **Gestión de cuentas:** Gestionar múltiples cuentas de Google/Claude es tedioso. +- 📊 **Uso a ciegas:** No sabes cuántos tokens has consumido o cuánta cuota queda. +- 🔌 **Problemas de integración:** Necesitas un proxy local confiable que hable los protocolos OpenAI/Anthropic de forma nativa. +- 🔍 **Falta de transparencia:** No puedes ver qué se envía o recibe exactamente a través del proxy. -**Gemini Nexus** resuelve todo esto. Es una aplicación de escritorio profesional en Electron que actúa como gateway inteligente entre tus herramientas de desarrollo y Google Gemini / Claude AI: +**Gemini Nexus** resuelve todo esto. Es una aplicación de escritorio profesional en Electron que actúa como gateway inteligente entre tus herramientas de desarrollo y Google Gemini / Claude AI. -- ✅ **Pool de Cuentas Ilimitado** — Agrega cualquier cantidad de cuentas Google Gemini y Claude -- ✅ **Cambio Automático Inteligente** — Rota automáticamente a la siguiente cuenta disponible cuando la cuota es baja -- ✅ **Analytics de Uso en Tiempo Real** — Dashboard nivel SaaS con gráficos de área, indicadores de tendencia y distribución por modelo -- ✅ **Observabilidad Completa del Proxy** — Monitor de tráfico en vivo, replay de solicitudes e inspector de capacidades de modelos -- ✅ **Compatible con OpenAI y Anthropic** — Proxy drop-in para Cursor, Windsurf, OpenCode y cualquier herramienta compatible -- ✅ **Seguro por Defecto** — Cifrado AES-256-GCM con gestión nativa de credenciales del SO +### Propuesta de Valor + +- ✅ **Pool de Cuentas Ilimitado** — Agrega cualquier cantidad de cuentas Google Gemini y Claude. +- ✅ **Cambio Automático Inteligente** — Rota automáticamente a la siguiente cuenta disponible cuando la cuota es baja o hay rate limit. +- ✅ **Analytics de Uso en Tiempo Real** — Dashboard nivel SaaS con gráficos de área, indicadores de tendencia y distribución por modelo. +- ✅ **Observabilidad Completa del Proxy** — Monitor de tráfico en vivo, replay de solicitudes e inspector de capacidades de modelos. +- ✅ **Compatible con OpenAI y Anthropic** — Proxy drop-in para Cursor, Windsurf, OpenCode y cualquier herramienta compatible con OpenAI. +- ✅ **Seguro por Defecto** — Cifrado AES-256-GCM con gestión nativa de credenciales del sistema operativo. --- @@ -79,7 +100,7 @@ Al usar IDEs y herramientas de programación con IA, ¿te has encontrado con est @@ -115,9 +120,9 @@ Ao usar IDEs e ferramentas de programação com IA, você já enfrentou estes pr

🔍 Observabilidade do Proxy (Avançado)

@@ -125,7 +130,7 @@ Ao usar IDEs e ferramentas de programação com IA, você já enfrentou estes pr

🔐 Segurança e Criptografia

@@ -183,14 +188,32 @@ Ao usar IDEs e ferramentas de programação com IA, você já enfrentou estes pr --- -## ⚡ Início Rápido +## ⚡ Instalação e Início Rápido -### Pré-requisitos +### 📦 Download + +Você pode baixar os binários pré-compilados mais recentes para Windows, macOS e Linux na nossa [página de Releases](https://github.com/evandrodevbr/GeminiNexus/releases). + +*(Consulte o aviso no topo desta página se você estiver usando o Windows e encontrar o prompt do SmartScreen).* + +### 🔌 Usando com IDEs de IA + +Com o aplicativo rodando e pelo menos uma conta adicionada, configure sua IDE preferida (Cursor, Windsurf, OpenCode, etc.): + +```plaintext +API Base URL: http://localhost:10100/v1 +API Key: (copie da página Proxy no app) +Model: gemini-3-flash (ou qualquer modelo mapeado) +``` + +### 🛠️ Compilando pelo Código Fonte + +#### Pré-requisitos - **Node.js** v20 ou superior - **npm** (este projeto usa `package-lock.json`) -### Compilando pelo Código Fonte +#### Passos ```bash # Clone o repositório @@ -203,21 +226,10 @@ npm install # Inicie o modo de desenvolvimento npm start -# Compile para produção (instalador Windows) +# Compile para produção (ex: instalador Windows) npm run make ``` -### Usando com IDEs de IA - -Com o proxy em execução, configure sua IDE: - -```plaintext -# Nas configurações do Cursor / Windsurf / OpenCode: -API Base URL: http://localhost:10100/v1 -API Key: (copie da página Proxy no app) -Model: gemini-3-flash (ou qualquer modelo mapeado) -``` - --- ## 🛠️ Stack Tecnológica @@ -280,41 +292,43 @@ src/ ## ❓ FAQ
-P: O app não inicia? +P: Aviso do Windows SmartScreen ("O Windows protegeu o seu computador") durante a instalação? -1. Certifique-se de que todas as dependências estão instaladas: `npm install` -2. Verifique se a versão do Node.js é >= 20 -3. Tente deletar `node_modules` e reinstalar -4. No Windows, certifique-se de que o WiX Toolset está disponível para `npm run make` +Sim, este é um aviso comum para novos aplicativos não assinados. Clique em **"Mais informações"** e depois em **"Executar mesmo assim"**. Veja o aviso no topo do README para mais detalhes. +
+
+P: O app não inicia ao compilar pelo código fonte? + +1. Certifique-se de que todas as dependências estão instaladas: `npm install`. +2. Verifique se a versão do Node.js é >= 20. +3. Tente deletar `node_modules` e reinstalar. +4. No Windows, certifique-se de que o WiX Toolset está disponível para o comando `npm run make`.
P: O login da conta falhou? -1. Verifique se a conexão com a internet está funcionando -2. Tente limpar os dados do app e fazer login novamente -3. Verifique se a conta está restrita pelo Google/Claude - +1. Verifique se a conexão com a internet está funcionando. +2. Tente limpar os dados do app e fazer login novamente. +3. Verifique se a conta está restrita pelo Google/Claude.
-P: A IDE não conecta no proxy? - -1. Certifique-se de que o proxy está rodando (indicador verde na barra de status) -2. Verifique se a porta corresponde à configuração da sua IDE (padrão: `10100`) -3. Copie a API key da página Proxy e cole nas configurações da sua IDE -4. Verifique se pelo menos uma conta está ativa na página de Contas +P: A IDE não consegue conectar ao proxy? +1. Certifique-se de que o proxy está rodando (indicador verde na barra de status). +2. Verifique se a porta corresponde à configuração da sua IDE (padrão: `10100`). +3. Copie a API key da página Proxy e cole nas configurações da sua IDE. +4. Verifique se pelo menos uma conta está ativa na página de Contas.
P: A contagem de tokens mostra zero? -1. Este era um bug conhecido em versões anteriores — atualize para a versão mais recente -2. O rastreamento de tokens agora lida corretamente com metadados de streaming e contagens estimadas -3. Os dados de uso são atualizados a cada 15 segundos na página de Analytics de Uso - +1. Este era um bug conhecido em versões anteriores — por favor, atualize para a versão mais recente. +2. O rastreamento de tokens agora lida corretamente com metadados de streaming e contagens estimadas. +3. Os dados de uso são atualizados a cada 15 segundos na página de Analytics de Uso.
--- diff --git a/README.zh-CN.md b/README.zh-CN.md index f264135..1c1df16 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -23,25 +23,48 @@ 许可证 平台 + Electron

+> [!IMPORTANT] +> **Windows 用户：** 如果在安装过程中看到 **“Windows 已保护你的电脑”** (SmartScreen) 警告，请点击 **“更多信息”** (More info)，然后点击 **“仍要运行”** (Run anyway)。这是未签名的新应用预期的安全提示，属于正常现象。 + +--- + +## 📖 目录 + +- [✨ 为什么选择 Gemini Nexus？](#-为什么选择-gemini-nexus) +- [🎯 功能特性](#-功能特性) +- [📸 截图](#-截图) +- [⚡ 安装与快速开始](#-安装与快速开始) +- [🛠️ 技术栈](#️-技术栈) +- [💻 开发](#-开发) +- [❓ 常见问题](#-常见问题) +- [🤝 参与贡献](#-参与贡献) +- [📄 许可证](#-许可证) + --- ## ✨ 为什么选择 Gemini Nexus？ -- 😫 单个账户配额很快用完，需要频繁手动切换 -- 🔄 管理多个 Google/Claude 账户非常繁琐 -- 📊 不知道已经消耗了多少 Token 或还剩多少配额 -- 🔌 需要一个可靠的本地 API 代理，支持 OpenAI/Anthropic 协议 +在使用 AI 驱动的 IDE 和编程工具时，你是否遇到过这些问题？ -**Gemini Nexus** 解决所有这些问题。它是一个专业的 Electron 桌面应用，作为你的开发工具和 Google Gemini / Claude AI 之间的智能网关： +- 😫 **配额限制：** 单个账户配额很快用完，需要频繁手动切换。 +- 🔄 **账户管理：** 管理多个 Google/Claude 账户非常繁琐。 +- 📊 **盲目使用：** 不知道已经消耗了多少 Token 或还剩多少配额。 +- 🔌 **集成问题：** 需要一个可靠的本地 API 代理，并且必须原生支持 OpenAI/Anthropic 协议。 +- 🔍 **缺乏透明度：** 无法查看代理在后台实际发送或接收的数据。 -- ✅ **无限账户池** — 添加任意数量的 Google Gemini 和 Claude 账户 -- ✅ **智能自动切换** — 当配额不足或被限速时自动轮换到下一个可用账户 -- ✅ **实时使用分析** — SaaS 级仪表板，配备面积图、趋势指标和模型分布 -- ✅ **完整的代理可观测性** — 实时流量监控、请求重放和模型能力检查器 -- ✅ **兼容 OpenAI 和 Anthropic** — 即插即用的代理，支持 Cursor、Windsurf、OpenCode -- ✅ **默认安全** — AES-256-GCM 加密，配合操作系统原生凭证管理 +**Gemini Nexus** 解决所有这些问题。它是一个专业的 Electron 桌面应用，作为你的开发工具和 Google Gemini / Claude AI 之间的智能网关。 + +### 核心价值主张 + +- ✅ **无限账户池** — 添加任意数量的 Google Gemini 和 Claude 账户。 +- ✅ **智能自动切换** — 当配额不足或被限速时自动轮换到下一个可用账户。 +- ✅ **实时使用分析** — SaaS 级仪表板，配备面积图、趋势指标和模型分布。 +- ✅ **完整的代理可观测性** — 实时流量监控、请求重放和模型能力检查器。 +- ✅ **兼容 OpenAI 和 Anthropic** — 即插即用的代理，支持 Cursor、Windsurf、OpenCode 以及任何兼容 OpenAI 的工具。 +- ✅ **默认安全** — AES-256-GCM 加密，配合操作系统原生凭证管理。 --- @@ -77,10 +100,10 @@ @@ -97,17 +120,17 @@

🔍 代理可观测性（高级）

🔐 安全与加密

@@ -119,6 +142,7 @@ @@ -128,8 +152,9 @@ @@ -163,31 +188,46 @@ --- -## ⚡ 快速开始 +## ⚡ 安装与快速开始 -### 前置要求 +### 📦 下载 -- **Node.js** v20 或更高版本 -- **npm** +您可以从我们的 [Releases 页面](https://github.com/evandrodevbr/GeminiNexus/releases) 下载适用于 Windows、macOS 和 Linux 的最新预编译版本。 -### 从源码构建 +*(如果您使用的是 Windows 并在安装时遇到了 SmartScreen 提示，请参阅页面顶部的警告)。* -```bash -git clone https://github.com/evandrodevbr/GeminiNexus.git -cd GeminiNexus -npm install -npm start +### 🔌 配合 AI IDE 使用 -# 构建生产版本 -npm run make -``` - -### 配合 AI IDE 使用 +在代理运行并至少添加一个账户后，配置您首选的 IDE（Cursor、Windsurf、OpenCode 等）： ```plaintext API Base URL: http://localhost:10100/v1 API Key: （从应用的 Proxy 页面复制） -Model: gemini-3-flash +Model: gemini-3-flash （或您选择的任何映射模型） +``` + +### 🛠️ 从源码构建 + +#### 前置要求 + +- **Node.js** v20 或更高版本 +- **npm** （本项目使用 `package-lock.json`） + +#### 步骤 + +```bash +# 克隆仓库 +git clone https://github.com/evandrodevbr/GeminiNexus.git +cd GeminiNexus + +# 安装依赖 +npm install + +# 启动开发环境 +npm start + +# 构建生产版本（例如 Windows 安装程序） +npm run make ``` --- @@ -207,27 +247,75 @@ Model: gemini-3-flash --- +## 💻 开发 + +```bash +# 启动开发环境 (Electron + Vite HMR) +npm start + +# 运行代码规范检查 +npm run lint + +# 类型检查 +npm run type-check + +# 格式化代码 +npm run format:write + +# 运行测试 +npm test +``` + +--- + ## ❓ 常见问题
-问：应用无法启动？ - -1. 确保依赖已安装：`npm install` -2. Node.js 版本 >= 20 -3. 尝试删除 `node_modules` 并重新安装 +问：安装时出现 Windows SmartScreen 警告（"Windows 已保护你的电脑"）？ +是的，对于未签名的新应用，这是一个常见的警告。请点击 **"更多信息"** (More info)，然后点击 **"仍要运行"** (Run anyway)。详情请参阅 README 顶部的提示。
-问：IDE 无法连接代理？ - -1. 确保代理正在运行（状态栏绿色指示器） -2. 确认端口一致（默认 `10100`） -3. 从 Proxy 页面复制 API 密钥 -4. 确保至少有一个账户处于活跃状态 +问：从源码构建时应用无法启动？ +1. 确保所有依赖均已安装：`npm install` +2. 检查 Node.js 版本是否 >= 20。 +3. 尝试删除 `node_modules` 并重新安装。 +4. 在 Windows 上，请确保已安装 WiX Toolset 以便执行 `npm run make` 命令。
+
+问：账户登录失败？ + +1. 确保您的网络连接正常。 +2. 尝试清除应用数据并重新登录。 +3. 检查该账户是否已被 Google/Claude 限制。 +
+ +
+问：IDE 无法连接到代理？ + +1. 确保代理正在运行（查看状态栏的绿色指示器）。 +2. 确认端口与您 IDE 中的配置一致（默认为 `10100`）。 +3. 直接从 Proxy 页面复制 API 密钥并粘贴到 IDE 设置中。 +4. 确保在 Accounts 页面中至少有一个活跃的账户。 +
+ +
+问：Token 计数显示为零？ + +1. 这是早期版本中的一个已知漏洞 — 请更新至最新版本。 +2. 目前 Token 追踪功能已能正确处理流式元数据及预估计数。 +3. 使用数据会在 Usage Analytics 页面每 15 秒自动刷新。 +
+ +--- + +## 🤝 参与贡献 + +欢迎贡献代码！详情请参阅 `CONTRIBUTING.md`。 + --- ## 📄 许可证 @@ -242,6 +330,8 @@ Model: gemini-3-flash > **仅供教育目的** > > 本项目仅供教育和研究目的使用。按"原样"提供，不提供任何担保。**严禁商业用途。** +> +> 使用本软件即表示您同意不会将其用于任何商业目的，并且您全权负责确保您的使用符合所有适用的法律和法规。作者和贡献者对因使用本软件而引起的任何滥用或损害不承担任何责任。 ---