docs: add feature screenshots and synchronize multilingual readmes

2026-07-21 14:53:56 +08:00
1 parent 43593d5149
commit ac89223739
@@ -11,35 +11,111 @@
 <h1 align="center">EasyCLIProxyAPI</h1>

 <p align="center">
-  私たちの目標は、トークンを free（無料ではなく、自由という意味）にすることです。<br>
+  CLIProxyAPI のポータブルデスクトップコンソール。<br>
+  私たちの目標は、トークンを free（無料ではなく、自由という意味）にすることです。
 </p>

-
 ## 概要

-EasyCLIProxyAPI は、[CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) をベースにしたポータブルツールです。コア、OAuth アカウント、API 接続、モデルルーティング、認証ファイル、クォータ情報、使用履歴、エージェントクライアント設定をグラフィカルなインターフェースから管理できます。
+EasyCLIProxyAPI は、[CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)
+をベースにしたグラフィカルなデスクトップ管理ツールです。コアのライフサイクル管理、OAuth 認証、
+API プロバイダー統合、プロトコル変換、認証情報管理、クォータ確認、使用履歴、モデルエイリアス、
+エージェントクライアント設定を一つの画面にまとめます。

-本アプリケーションは Tauri、React、Rust で構築されています。
+本アプリケーションは Tauri、React、Rust で構築されています。対応する CLIProxyAPI コアの
+アーカイブを同梱できるため、初回セットアップやオフラインインストールも簡単です。

-## 主な機能
+## 機能紹介

- OAuth アカウントログイン
-  - Codex、Claude、Gemini などのアカウントログインに対応
+### コアダッシュボードとバージョン管理

- API 統合管理
-  - OpenAI、Claude、Gemini などのプロトコルを使用した API Key 接続に対応
+![コアダッシュボードとバージョン管理](docs/images/1.png)

- API フォーマット変換
-  - OpenAI、Claude、Gemini などのプロトコル間でリクエストとレスポンスの形式を相互変換
+コア画面では、ローカルプロキシの状態確認と操作を一か所で行えます。

- エージェントクライアント設定
-  - Claude Code、Claude Desktop、Codex、OpenCode、OpenClaw、Hermes Agent などの主要なエージェントクライアントを自動設定
+- CLIProxyAPI コアの起動、停止、再起動、状態更新。
+- インストール状態、実行状態、プロセス ID、待受ポート、LAN アクセス設定の確認。
+- インストール済み、最新、アプリ同梱のコアバージョンを比較。
+- 最新版のインストール、再インストール、または GitHub に接続できない場合のオフラインインストール。
+- OpenAI、Claude、Gemini 互換の API エンドポイントをそのままコピー。
+- EasyCLIProxyAPI のバージョンとローカル接続状態を同じ画面で確認。
+
+### OAuth アカウント認証
+
+![OAuth アカウント認証](docs/images/2.png)
+
+OAuth 画面では、対応プロバイダーのブラウザー認証をまとめて管理できます。
+
+- Codex OAuth
+- Claude OAuth
+- Antigravity OAuth
+- Kimi OAuth
+- xAI OAuth
+
+EasyCLIProxyAPI はブラウザーで認証ページを開きます。自動リダイレクトが利用できない場合は、
+コールバックを手動で完了することもできます。
+
+### API プロバイダー統合
+
+![API プロバイダー統合](docs/images/3.png)
+
+API 接続画面では、プロトコルまたはプロバイダーごとに上流 API の認証情報と接続先を管理できます。
+
+- Codex
+- OpenAI 互換プロバイダー
+- DeepSeek
+- Claude
+- Gemini
+
+複数の接続設定を追加し、既存設定の検索やプロバイダー状態の更新を行えます。すべての接続は、
+統一されたローカル CLIProxyAPI エンドポイントから利用できます。リクエストとレスポンスは、
+OpenAI、Claude、Gemini、およびその他の互換形式の間で変換できます。
+
+### エージェントクライアント設定
+
+![エージェントクライアント設定](docs/images/4.png)
+
+エージェント画面は、インストール済みのデスクトップクライアントと CLI クライアントを検出し、
+ローカルプロキシへの接続を支援します。対応クライアントは次のとおりです。
+
+- Claude Code
+- Claude Desktop
+- Codex
+- OpenCode
+- OpenClaw
+- Hermes Agent
+
+対応クライアントでは、利用可能なモデルカタログの同期、デフォルトモデルの選択、管理設定を適用する前の
+元設定のバックアップ、以前の設定への復元、利用可能なデスクトップまたは CLI エントリーポイントの起動ができます。
+
+## その他の機能
+
+- コア設定、API Key、リモート管理用認証情報、プラグイン、ルーティング戦略の管理。
+- クライアント向けモデルエイリアスを作成し、プロバイダーモデルや推論レベルへマッピング。
+- 認証ファイルのアップロード、ダウンロード、確認、管理。
+- プロバイダーのクォータとアカウント利用状態を確認。
+- ローカルの使用履歴とトークン統計を閲覧。
+- macOS メニューバーまたは Windows システムトレイからバックグラウンド動作を継続。
+
+## クイックスタート
+
+1. [GitHub Releases](https://github.com/router-for-me/EasyCLIProxyAPI/releases/latest)
+   から、お使いの OS に対応するパッケージをダウンロードします。
+2. Windows または Linux のアーカイブを展開します。macOS では DMG を開きます。
+3. EasyCLIProxyAPI を起動します。
+4. **コア** 画面を開き、同梱版または最新版の CLIProxyAPI コアをインストールします。
+5. コアを起動し、必要なローカル API エンドポイントをコピーするか、OAuth/API プロバイダーを設定します。

 ## 対応プラットフォーム

-現在、GitHub Actions では以下のポータブルリリースパッケージを生成しています。
+GitHub Actions では、次のリリースパッケージをビルドします。

-| OS | アーキテクチャ |
-| --- | --- |
-| Windows | amd64、aarch64 |
-| Linux | amd64、aarch64 |
+| OS | アーキテクチャ | 形式 |
+| --- | --- | --- |
+| Windows | amd64、aarch64 | ZIP |
+| macOS | amd64、aarch64 | DMG |
+| Linux | amd64、aarch64 | TAR.GZ |
+
+## 関連プロジェクト
+
+- [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) — 本アプリケーションが管理するプロキシコアです。
@@ -11,35 +11,112 @@
 <h1 align="center">EasyCLIProxyAPI</h1>

 <p align="center">
-  Our goal is to make tokens free—as in freedom.<br>
+  A portable desktop console for CLIProxyAPI.<br>
+  Our goal is to make tokens free—as in freedom.
 </p>

-
 ## Overview

-EasyCLIProxyAPI is a portable tool built on [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI). It provides a graphical interface for managing the core, OAuth accounts, API providers, model routing, authentication files, quota information, usage records, and agent client configurations.
+EasyCLIProxyAPI is a graphical desktop management tool built on
+[CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI). It brings core lifecycle management,
+OAuth authorization, API provider aggregation, protocol conversion, credential management,
+quota inspection, usage records, model aliases, and agent client configuration into one interface.

-The application is built with Tauri, React, and Rust.
+The application is built with Tauri, React, and Rust. It can carry a matching CLIProxyAPI core
+archive, making first-time setup and offline installation easier.

-## Key Features
+## Feature Tour

- OAuth account sign-in
-  - Supports signing in with Codex, Claude, Gemini, and more
+### Core dashboard and version management

- API aggregation management
-  - Supports API Key integrations using OpenAI, Claude, Gemini, and other protocols
+![Core dashboard and version management](docs/images/1.png)

- API format conversion
-  - Converts request and response formats between OpenAI, Claude, Gemini, and other protocols
+The core dashboard provides a complete view of the local proxy runtime:

- Agent client configuration
-  - Automatically configures popular agent clients including Claude Code, Claude Desktop, Codex, OpenCode, OpenClaw, and Hermes Agent
+- 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.
+- Copy ready-to-use OpenAI, Claude, and Gemini-compatible API endpoints.
+- Check the EasyCLIProxyAPI application version and local connectivity from one page.
+
+### OAuth account authorization
+
+![OAuth account authorization](docs/images/2.png)
+
+The OAuth page centralizes browser-based authorization for supported providers:
+
+- Codex OAuth
+- Claude OAuth
+- Antigravity OAuth
+- Kimi OAuth
+- xAI OAuth
+
+EasyCLIProxyAPI opens the authorization page in the browser and supports completing the callback
+flow when an automatic redirect is unavailable.
+
+### API provider aggregation
+
+![API provider aggregation](docs/images/3.png)
+
+The provider workspace manages upstream API credentials and endpoints by protocol or provider:
+
+- Codex
+- OpenAI-compatible providers
+- DeepSeek
+- Claude
+- Gemini
+
+You can add multiple connections, search existing entries, refresh provider state, and use them
+through the unified local CLIProxyAPI endpoint. Requests and responses can be converted between
+supported OpenAI, Claude, Gemini, and compatible formats.
+
+### Agent client configuration
+
+![Agent client configuration](docs/images/4.png)
+
+The agent client page detects installed desktop and CLI clients and helps connect them to the
+local proxy. Supported clients include:
+
+- Claude Code
+- Claude Desktop
+- Codex
+- OpenCode
+- OpenClaw
+- Hermes Agent
+
+For supported clients, the application can synchronize the available model catalog, select a
+default model, back up the original configuration before applying managed settings, restore the
+previous configuration, and launch an available desktop or CLI entry point.
+
+## Additional Capabilities
+
+- Manage core settings, API keys, remote management credentials, plugins, and routing strategy.
+- 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
+
+1. Download the package for your operating system from
+   [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.

 ## Supported Platforms

-GitHub Actions currently produces the following portable release packages:
+GitHub Actions builds the following release packages:

-| Operating System | Architecture |
-| --- | --- |
-| Windows | amd64, aarch64 |
-| Linux | amd64, aarch64 |
+| Operating System | Architecture | Package |
+| --- | --- | --- |
+| Windows | amd64, aarch64 | ZIP |
+| macOS | amd64, aarch64 | DMG |
+| Linux | amd64, aarch64 | TAR.GZ |
+
+## Related Project
+
+- [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) — the proxy core managed by this application.
@@ -11,35 +11,107 @@
 <h1 align="center">EasyCLIProxyAPI</h1>

 <p align="center">
-  我们的目标是实现 token free（free 在这里的意思是自由）。<br>
+  CLIProxyAPI 的便携桌面控制台。<br>
+  我们的目标是实现 token free（free 在这里的意思是自由）。
 </p>

-
 ## 项目简介

-EasyCLIProxyAPI 是基于 [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) 的便携工具，提供图形化界面管理内核、OAuth 账号、API 接入、模型路由、认证文件、配额查询、使用记录和智能体客户端配置。
+EasyCLIProxyAPI 是基于 [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)
+构建的图形化桌面管理工具。它将内核生命周期管理、OAuth 授权、API Provider 聚合、协议转换、
+凭证管理、配额查询、使用记录、模型别名和智能体客户端配置集中到一个界面中。

-软件基于 Tauri、React 和 Rust 构建。
+软件基于 Tauri、React 和 Rust 构建，并可携带匹配版本的 CLIProxyAPI 内核压缩包，
+让首次安装和离线安装更加方便。

-## 主要功能
+## 功能导览

- OAuth 账号登录
-  - 支持 Codex、Claude、Gemini 等账号登录
+### 内核控制台与版本管理

- API 聚合管理
-  - 支持 OpenAI、Claude、Gemini 等协议的 API Key 接入
+![内核控制台与版本管理](docs/images/1.png)

- API 格式互转
-  - 支持 OpenAI、Claude、Gemini 等协议的请求和响应格式互转
+内核页面集中展示本地代理服务的运行情况，并提供完整的控制能力：

- 智能体客户端配置
-  - 自动配置 Claude Code、Claude Desktop、Codex、OpenCode、OpenClaw 和 Hermes Agent 等主流智能体客户端
+- 启动、关闭、重启和刷新 CLIProxyAPI 内核状态。
+- 查看安装状态、运行状态、进程 PID、监听端口和局域网访问设置。
+- 对比当前版本、最新版本和软件内置的内核版本。
+- 安装最新版、重新安装，或在无法连接 GitHub 时使用离线安装包。
+- 复制可直接使用的 OpenAI、Claude 和 Gemini 兼容 API 地址。
+- 在同一页面查看 EasyCLIProxyAPI 软件版本和本地连接状态。
+
+### OAuth 账号授权
+
+![OAuth 账号授权](docs/images/2.png)
+
+OAuth 页面集中管理支持的浏览器授权登录：
+
+- Codex OAuth
+- Claude OAuth
+- Antigravity OAuth
+- Kimi OAuth
+- xAI OAuth
+
+EasyCLIProxyAPI 会自动打开浏览器授权页面；当浏览器无法自动跳转回来时，也支持手动完成回调流程。
+
+### API Provider 聚合管理
+
+![API Provider 聚合管理](docs/images/3.png)
+
+API 接入页面按照协议或 Provider 管理上游 API 凭证和服务地址：
+
+- Codex
+- OpenAI 兼容 Provider
+- DeepSeek
+- Claude
+- Gemini
+
+你可以添加多个接入配置、搜索已有配置、刷新 Provider 状态，并通过统一的本地 CLIProxyAPI
+地址调用它们。请求和响应可以在 OpenAI、Claude、Gemini 及其他兼容协议之间转换。
+
+### 智能体客户端配置
+
+![智能体客户端配置](docs/images/4.png)
+
+智能体页面会检测本机已安装的桌面端和命令行客户端，并帮助它们连接本地代理。支持的客户端包括：
+
+- Claude Code
+- Claude Desktop
+- Codex
+- OpenCode
+- OpenClaw
+- Hermes Agent
+
+对于受支持的客户端，软件可以同步可用模型目录、选择默认模型、在应用托管配置前备份原始配置、
+恢复之前的配置，以及启动可用的桌面端或命令行入口。
+
+## 其他功能
+
+- 管理内核配置、API Key、远程管理凭证、插件和路由策略。
+- 创建客户端可见的模型别名，并映射到 Provider 模型和推理等级。
+- 上传、下载、检查和管理认证文件。
+- 查看 Provider 配额和账号可用状态。
+- 浏览本地使用记录和 Token 统计数据。
+- 通过 macOS 菜单栏或 Windows 系统托盘保持软件在后台运行。
+
+## 快速开始
+
+1. 前往 [GitHub Releases](https://github.com/router-for-me/EasyCLIProxyAPI/releases/latest)
+   下载对应操作系统的发行包。
+2. 解压 Windows 或 Linux 压缩包，macOS 用户打开 DMG。
+3. 启动 EasyCLIProxyAPI。
+4. 打开 **内核** 页面，安装内置版本或最新版本的 CLIProxyAPI 内核。
+5. 启动内核，然后复制所需的本地 API 地址，或配置 OAuth/API Provider。

 ## 支持的平台

-当前 GitHub Actions 生成以下便携发行包：
+GitHub Actions 会构建以下发行包：

-| 系统 | 架构 |
-| --- | --- |
-| Windows | amd64、aarch64 |
-| Linux | amd64、aarch64 |
+| 操作系统 | 架构 | 格式 |
+| --- | --- | --- |
+| Windows | amd64、aarch64 | ZIP |
+| macOS | amd64、aarch64 | DMG |
+| Linux | amd64、aarch64 | TAR.GZ |
+
+## 相关项目
+
+- [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) — 本软件负责管理的代理内核。