diff --git a/docs/content/index.md b/docs/content/index.md index 5025068a7..97c8d3aa8 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -1,137 +1,136 @@ --- -title: ProxyCast -description: 把你的 AI 客户端额度用到任何地方 +title: ProxyCast - 把你的 AI 客户端额度用到任何地方 +description: 一款基于 Tauri 的桌面应用，将 Kiro、Gemini CLI、Qwen 等 AI 客户端凭证转换为标准 OpenAI/Claude 兼容 API navigation: false -layout: page --- -::hero ---- -announcement: - title: 🎉 ProxyCast v1.0 发布 - icon: i-heroicons-megaphone - to: /introduction/overview -actions: - - label: 快速开始 - icon: i-heroicons-rocket-launch - to: /introduction/quickstart - color: primary - - label: GitHub - icon: i-simple-icons-github - to: https://github.com/aiclientproxy/proxycast - target: _blank - color: neutral ---- +
-#title -ProxyCast +
+

ProxyCast

+

把你的 AI 客户端额度用到任何地方

+

一款基于 Tauri 的桌面应用，将 Kiro、Gemini CLI、Qwen 等 AI 客户端凭证转换为标准 OpenAI/Claude 兼容 API

+

凭证池管理 • 智能路由 • 协议转换 • 容错机制

+
+ 快速开始 + GitHub +
+
-#description -把你的 AI 客户端额度用到任何地方。一款基于 Tauri 的桌面应用，将 Kiro、Gemini CLI、Qwen 等 AI 客户端凭证转换为标准 OpenAI/Claude 兼容 API。 -:: +
+

+ ⚠️ 免责声明: 本工具仅限于个人合法使用，严禁用于非法盈利目的。初衷是帮助用户充分利用已订阅的 AI 服务 Token。 + 查看完整声明 +

+
-::alert{type="warning"} -**免责声明**: 本工具仅限于个人合法使用，严禁用于非法盈利目的。初衷是帮助用户充分利用已订阅的 AI 服务 Token。[查看完整声明](/legal/disclaimer) -:: +## ✨ 核心特性 -::card-group - ::card - --- - title: 凭证池管理 - icon: i-heroicons-key - to: /user-guide/credential-pool - --- - 支持多种 AI 客户端凭证的统一管理，包括 Kiro、Gemini CLI、Qwen、Claude Code 等。 - :: +
+
+

🔑 凭证池管理

+

支持多种 AI 客户端凭证的统一管理，包括 Kiro、Gemini CLI、Qwen、Claude Code 等，自动检测和刷新 OAuth Token。

+
+
+

🔀 智能路由

+

基于模型名称的请求路由，支持负载均衡、优先级配置、健康检查和自动故障转移。

+
+
+

🛡️ 容错配置

+

内置熔断器、重试机制、超时控制，确保服务稳定性，优雅处理 API 故障。

+
+
+

⚡ 配置切换

+

一键切换 Claude Code、Codex、Gemini CLI 等客户端配置，快速适应不同使用场景。

+
+
+

📊 监控统计

+

实时监控请求统计、Token 使用追踪、详细的请求日志和性能指标。

+
+
+

🔌 API 兼容

+

完整支持 OpenAI Chat Completions API 和 Claude Messages API，无缝集成现有工具。

+
+
- ::card - --- - title: 智能路由 - icon: i-heroicons-arrows-right-left - to: /user-guide/smart-routing - --- - 基于负载均衡、优先级、健康检查的智能请求路由策略。 - :: +## 🎯 支持的 Provider - ::card - --- - title: 容错配置 - icon: i-heroicons-shield-check - to: /user-guide/resilience - --- - 内置熔断器、重试机制、超时控制，确保服务稳定性。 - :: +| Provider | 类型 | 认证方式 | 说明 | +|----------|------|----------|------| +| Kiro Claude | OAuth | 自动刷新 | AWS Kiro IDE 的 Claude 凭证 | +| Gemini CLI | OAuth | 自动刷新 | Google Gemini CLI 凭证 | +| Qwen (通义千问) | OAuth | 自动刷新 | 阿里云通义千问凭证 | +| OpenAI Custom | API Key | 手动配置 | 自定义 OpenAI 兼容服务 | +| Claude Custom | API Key | 手动配置 | 自定义 Claude 兼容服务 | - ::card - --- - title: 配置切换 - icon: i-heroicons-cog-6-tooth - to: /user-guide/config-switch - --- - 一键切换 Claude Code、Codex、Gemini CLI 等客户端配置。 - :: -:: +## 🚀 快速开始 -::section -#title -核心特性 +### 1. 下载安装 -#description -ProxyCast 提供完整的 AI 客户端代理解决方案 +从 [GitHub Releases](https://github.com/aiclientproxy/proxycast/releases) 下载适合你系统的安装包。 -::card-group - ::card - --- - title: 仪表盘 - icon: i-heroicons-chart-bar - to: /user-guide/dashboard - --- - 实时监控请求统计、凭证状态、系统健康度。 - :: +### 2. 加载凭证 - ::card - --- - title: 监控中心 - icon: i-heroicons-eye - to: /user-guide/monitoring - --- - 详细的请求日志、性能指标、错误追踪。 - :: +ProxyCast 会自动检测本地的 AI 客户端凭证文件： - ::card - --- - title: API Server - icon: i-heroicons-server - to: /user-guide/api-server - --- - OpenAI/Claude 兼容的 API 服务端点。 - :: +``` +~/.kiro/credentials.json # Kiro Claude +~/.config/gemini-cli/oauth_creds.json # Gemini CLI +~/.config/qwen/credentials.json # Qwen +``` - ::card - --- - title: MCP 支持 - icon: i-heroicons-puzzle-piece - to: /user-guide/mcp - --- - Model Context Protocol 集成支持。 - :: +### 3. 启动服务 - ::card - --- - title: Prompts 管理 - icon: i-heroicons-document-text - to: /user-guide/prompts - --- - 系统提示词模板管理与复用。 - :: +点击仪表盘的「启动服务」按钮，API Server 默认运行在 `http://127.0.0.1:9090`。 - ::card - --- - title: Skills 技能 - icon: i-heroicons-sparkles - to: /user-guide/skills - --- - 可扩展的技能模块系统。 - :: -:: -:: +### 4. 测试 API + +```bash +curl http://127.0.0.1:9090/v1/chat/completions \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer your-api-key" \ + -d '{ + "model": "claude-sonnet-4-20250514", + "messages": [{"role": "user", "content": "Hello!"}] + }' +``` + +## 📖 文档导航 + +
+ +

📋 概述

+

了解 ProxyCast 的核心功能和价值

+ + +

📥 安装指南

+

下载并安装 ProxyCast

+ + +

🚀 快速开始

+

5 分钟内完成首次 API 调用

+ + +

🔧 Provider 配置

+

配置各种 AI 服务提供商

+ + +

📚 API 参考

+

完整的 API 端点文档

+ + +

🔍 故障排除

+

常见问题和解决方案

+ +
+ +## 🤝 社区与支持 + +- **GitHub Issues**: [报告问题](https://github.com/aiclientproxy/proxycast/issues) +- **GitHub Discussions**: [参与讨论](https://github.com/aiclientproxy/proxycast/discussions) + +## 📄 开源协议 + +ProxyCast 采用 [MIT License](https://github.com/aiclientproxy/proxycast/blob/main/LICENSE) 开源。 + +