diff --git a/README.ja.md b/README.ja.md index 1c6119f..8327d1b 100644 --- a/README.ja.md +++ b/README.ja.md @@ -29,7 +29,7 @@ API プロバイダー統合、プロトコル変換、認証情報管理、ク ### コアダッシュボードとバージョン管理 -![コアダッシュボードとバージョン管理](docs/images/1.png) +![コアダッシュボードとバージョン管理](docs/screenshots/zh-CN/1.png) コア画面では、ローカルプロキシの状態確認と操作を一か所で行えます。 @@ -42,7 +42,7 @@ API プロバイダー統合、プロトコル変換、認証情報管理、ク ### OAuth アカウント認証 -![OAuth アカウント認証](docs/images/2.png) +![OAuth アカウント認証](docs/screenshots/zh-CN/2.png) OAuth 画面では、対応プロバイダーのブラウザー認証をまとめて管理できます。 @@ -57,7 +57,7 @@ EasyCLIProxyAPI はブラウザーで認証ページを開きます。自動リ ### API プロバイダー統合 -![API プロバイダー統合](docs/images/3.png) +![API プロバイダー統合](docs/screenshots/zh-CN/3.png) API 接続画面では、プロトコルまたはプロバイダーごとに上流 API の認証情報と接続先を管理できます。 @@ -73,7 +73,7 @@ OpenAI、Claude、Gemini、およびその他の互換形式の間で変換で ### エージェントクライアント設定 -![エージェントクライアント設定](docs/images/4.png) +![エージェントクライアント設定](docs/screenshots/zh-CN/4.png) エージェント画面は、インストール済みのデスクトップクライアントと CLI クライアントを検出し、 ローカルプロキシへの接続を支援します。対応クライアントは次のとおりです。 diff --git a/README.md b/README.md index ce89c9e..1e079db 100644 --- a/README.md +++ b/README.md @@ -27,22 +27,23 @@ archive, making first-time setup and offline installation easier. ## Feature Tour -### Core dashboard and version management +### Home dashboard and local API endpoints -![Core dashboard and version management](docs/images/1.png) +![Home dashboard and local API endpoints](docs/screenshots/en/1.png) -The core dashboard provides a complete view of the local proxy runtime: +The Home page provides a quick overview of the local proxy runtime and ready-to-use API endpoints: - Start, stop, restart, and refresh the CLIProxyAPI core. -- View installation state, runtime state, process ID, listening port, and LAN access settings. -- Compare the installed, latest, and bundled core versions. -- Install the latest core, reinstall it, or use an offline package when GitHub is unavailable. +- View installation state, runtime state, process ID, and listening port. - Copy ready-to-use OpenAI, Claude, and Gemini-compatible API endpoints. -- Check the EasyCLIProxyAPI application version and local connectivity from one page. +- Check local connectivity and the application/core version at a glance. + +Core installation, version comparison, and offline installation are available from the +**Version Management** page. ### OAuth account authorization -![OAuth account authorization](docs/images/2.png) +![OAuth account authorization](docs/screenshots/en/2.png) The OAuth page centralizes browser-based authorization for supported providers: @@ -57,7 +58,7 @@ flow when an automatic redirect is unavailable. ### API provider aggregation -![API provider aggregation](docs/images/3.png) +![API provider aggregation](docs/screenshots/en/3.png) The provider workspace manages upstream API credentials and endpoints by protocol or provider: @@ -71,12 +72,23 @@ You can add multiple connections, search existing entries, refresh provider stat through the unified local CLIProxyAPI endpoint. Requests and responses can be converted between supported OpenAI, Claude, Gemini, and compatible formats. +### Usage history and token analytics + +![Usage history and token analytics](docs/screenshots/en/4.png) + +The Usage page helps you understand local request activity and token consumption: + +- Review request totals, token counts, success rate, throughput, cache hit rate, and estimated cost. +- Filter usage by time, model, provider, source, key, and result. +- Inspect request/token trends and input, output, reasoning, and cache usage. +- Browse request details, analysis views, and price statistics. + ### Agent client configuration -![Agent client configuration](docs/images/4.png) +![Agent client configuration](docs/screenshots/en/5.png) -The agent client page detects installed desktop and CLI clients and helps connect them to the -local proxy. Supported clients include: +The Agents page detects installed desktop and CLI clients and helps connect them to the local +proxy. Supported clients include: - Claude Code - Claude Desktop @@ -95,7 +107,6 @@ previous configuration, and launch an available desktop or CLI entry point. - Create client-visible model aliases and map them to provider models and reasoning levels. - Upload, download, inspect, and manage authentication files. - Review provider quotas and account availability. -- Browse local usage records and token statistics. - Keep the application available from the macOS menu bar or Windows system tray. ## Quick Start @@ -104,8 +115,8 @@ previous configuration, and launch an available desktop or CLI entry point. [GitHub Releases](https://github.com/router-for-me/EasyCLIProxyAPI/releases/latest). 2. Extract the Windows or Linux archive, or open the macOS DMG. 3. Launch EasyCLIProxyAPI. -4. Open the **Core** page and install the bundled or latest CLIProxyAPI core. -5. Start the core, then copy the required local endpoint or configure an OAuth/API provider. +4. Open **Version Management** and install the bundled or latest CLIProxyAPI core. +5. Return to **Home**, start the core, then copy the required local endpoint or configure an OAuth/API provider. ## Upgrading diff --git a/README.zh-CN.md b/README.zh-CN.md index 6f431f4..9ae0607 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -26,22 +26,22 @@ EasyCLIProxyAPI 是基于 [CLIProxyAPI](https://github.com/router-for-me/CLIProx ## 功能导览 -### 内核控制台与版本管理 +### 首页与本地 API 地址 -![内核控制台与版本管理](docs/images/1.png) +![首页与本地 API 地址](docs/screenshots/zh-CN/1.png) -内核页面集中展示本地代理服务的运行情况,并提供完整的控制能力: +首页集中展示本地代理服务的运行情况,并提供常用的本地 API 地址: - 启动、关闭、重启和刷新 CLIProxyAPI 内核状态。 -- 查看安装状态、运行状态、进程 PID、监听端口和局域网访问设置。 -- 对比当前版本、最新版本和软件内置的内核版本。 -- 安装最新版、重新安装,或在无法连接 GitHub 时使用离线安装包。 +- 查看安装状态、运行状态、进程 PID、内核版本和软件版本。 - 复制可直接使用的 OpenAI、Claude 和 Gemini 兼容 API 地址。 -- 在同一页面查看 EasyCLIProxyAPI 软件版本和本地连接状态。 +- 查看本地连接状态。 + +内核安装、版本对比和离线安装功能位于 **版本管理** 页面。 ### OAuth 账号授权 -![OAuth 账号授权](docs/images/2.png) +![OAuth 账号授权](docs/screenshots/zh-CN/2.png) OAuth 页面集中管理支持的浏览器授权登录: @@ -53,9 +53,9 @@ OAuth 页面集中管理支持的浏览器授权登录: EasyCLIProxyAPI 会自动打开浏览器授权页面;当浏览器无法自动跳转回来时,也支持手动完成回调流程。 -### API Provider 聚合管理 +### API 接入与 Provider 聚合 -![API Provider 聚合管理](docs/images/3.png) +![API 接入与 Provider 聚合](docs/screenshots/zh-CN/3.png) API 接入页面按照协议或 Provider 管理上游 API 凭证和服务地址: @@ -65,12 +65,24 @@ API 接入页面按照协议或 Provider 管理上游 API 凭证和服务地址 - Claude - Gemini -你可以添加多个接入配置、搜索已有配置、刷新 Provider 状态,并通过统一的本地 CLIProxyAPI -地址调用它们。请求和响应可以在 OpenAI、Claude、Gemini 及其他兼容协议之间转换。 +你可以添加多个接入配置、搜索已有配置、刷新 Provider 状态并执行健康检测, +然后通过统一的本地 CLIProxyAPI 地址调用它们。请求和响应可以在 OpenAI、Claude、Gemini +及其他兼容协议之间转换。 + +### 使用记录与 Token 统计 + +![使用记录与 Token 统计](docs/screenshots/zh-CN/4.png) + +使用记录页面帮助你了解本地请求活动和 Token 消耗情况: + +- 查看请求总数、Token 总量、成功率、TPS、缓存命中率和预估成本。 +- 按时间、模型、Provider、来源、密钥和结果筛选数据。 +- 查看请求与 Token 趋势,以及输入、输出、思考和缓存用量构成。 +- 浏览请求明细、分析视图和价格统计。 ### 智能体客户端配置 -![智能体客户端配置](docs/images/4.png) +![智能体客户端配置](docs/screenshots/zh-CN/5.png) 智能体页面会检测本机已安装的桌面端和命令行客户端,并帮助它们连接本地代理。支持的客户端包括: @@ -90,7 +102,6 @@ API 接入页面按照协议或 Provider 管理上游 API 凭证和服务地址 - 创建客户端可见的模型别名,并映射到 Provider 模型和推理等级。 - 上传、下载、检查和管理认证文件。 - 查看 Provider 配额和账号可用状态。 -- 浏览本地使用记录和 Token 统计数据。 - 通过 macOS 菜单栏或 Windows 系统托盘保持软件在后台运行。 ## 快速开始 @@ -99,8 +110,8 @@ API 接入页面按照协议或 Provider 管理上游 API 凭证和服务地址 下载对应操作系统的发行包。 2. 解压 Windows 或 Linux 压缩包,macOS 用户打开 DMG。 3. 启动 EasyCLIProxyAPI。 -4. 打开 **内核** 页面,安装内置版本或最新版本的 CLIProxyAPI 内核。 -5. 启动内核,然后复制所需的本地 API 地址,或配置 OAuth/API Provider。 +4. 打开 **版本管理** 页面,安装内置版本或最新版本的 CLIProxyAPI 内核。 +5. 返回 **首页** 启动内核,然后复制所需的本地 API 地址,或配置 OAuth/API Provider。 ## 升级 diff --git a/docs/images/1.png b/docs/images/1.png deleted file mode 100644 index 27fac00..0000000 Binary files a/docs/images/1.png and /dev/null differ diff --git a/docs/images/2.png b/docs/images/2.png deleted file mode 100644 index 1e24cc4..0000000 Binary files a/docs/images/2.png and /dev/null differ diff --git a/docs/images/3.png b/docs/images/3.png deleted file mode 100644 index a24e351..0000000 Binary files a/docs/images/3.png and /dev/null differ diff --git a/docs/images/4.png b/docs/images/4.png deleted file mode 100644 index 4249c39..0000000 Binary files a/docs/images/4.png and /dev/null differ diff --git a/docs/screenshots/en/1.png b/docs/screenshots/en/1.png new file mode 100644 index 0000000..3869726 Binary files /dev/null and b/docs/screenshots/en/1.png differ diff --git a/docs/screenshots/en/2.png b/docs/screenshots/en/2.png new file mode 100644 index 0000000..355cbd1 Binary files /dev/null and b/docs/screenshots/en/2.png differ diff --git a/docs/screenshots/en/3.png b/docs/screenshots/en/3.png new file mode 100644 index 0000000..1905d80 Binary files /dev/null and b/docs/screenshots/en/3.png differ diff --git a/docs/screenshots/en/4.png b/docs/screenshots/en/4.png new file mode 100644 index 0000000..8527d7c Binary files /dev/null and b/docs/screenshots/en/4.png differ diff --git a/docs/screenshots/en/5.png b/docs/screenshots/en/5.png new file mode 100644 index 0000000..f74664d Binary files /dev/null and b/docs/screenshots/en/5.png differ diff --git a/docs/screenshots/zh-CN/1.png b/docs/screenshots/zh-CN/1.png new file mode 100644 index 0000000..a2299c1 Binary files /dev/null and b/docs/screenshots/zh-CN/1.png differ diff --git a/docs/screenshots/zh-CN/2.png b/docs/screenshots/zh-CN/2.png new file mode 100644 index 0000000..de9b689 Binary files /dev/null and b/docs/screenshots/zh-CN/2.png differ diff --git a/docs/screenshots/zh-CN/3.png b/docs/screenshots/zh-CN/3.png new file mode 100644 index 0000000..e67265a Binary files /dev/null and b/docs/screenshots/zh-CN/3.png differ diff --git a/docs/screenshots/zh-CN/4.png b/docs/screenshots/zh-CN/4.png new file mode 100644 index 0000000..505ce40 Binary files /dev/null and b/docs/screenshots/zh-CN/4.png differ diff --git a/docs/screenshots/zh-CN/5.png b/docs/screenshots/zh-CN/5.png new file mode 100644 index 0000000..b4dcda3 Binary files /dev/null and b/docs/screenshots/zh-CN/5.png differ