lzt404
6d7da20e4e
- support built-in and user-defined GitHub mirror sources - add a modal for managing custom HTTPS mirror prefixes - automatically switch sources when version checks fail - persist the working source and sync the selector in real time - update translations, configuration migration, and source tests
148 lines
8.4 KiB
Markdown
148 lines
8.4 KiB
Markdown
<p align="center">
|
||
<a href="README.md">English</a> |
|
||
<a href="README.zh-CN.md">简体中文</a> |
|
||
<strong>日本語</strong>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<img src="src/assets/logo.jpg" width="112" alt="EasyCLIProxyAPI Logo">
|
||
</p>
|
||
|
||
<h1 align="center">EasyCLIProxyAPI</h1>
|
||
|
||
<p align="center">
|
||
CLIProxyAPI のポータブルデスクトップコンソール。<br>
|
||
私たちの目標は、トークンを free（無料ではなく、自由という意味）にすることです。
|
||
</p>
|
||
|
||
## 概要
|
||
|
||
EasyCLIProxyAPI は、[CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI)
|
||
をベースにしたグラフィカルなデスクトップ管理ツールです。コアのライフサイクル管理、OAuth 認証、
|
||
API プロバイダー統合、プロトコル変換、認証情報管理、クォータ確認、使用履歴、モデルエイリアス、
|
||
エージェントクライアント設定を一つの画面にまとめます。
|
||
|
||
本アプリケーションは Tauri、React、Rust で構築されています。対応する CLIProxyAPI コアの
|
||
アーカイブを同梱できるため、初回セットアップやオフラインインストールも簡単です。
|
||
|
||
## 機能紹介
|
||
|
||
### ホーム画面とローカル API エンドポイント
|
||
|
||
|
||
|
||
ホーム画面では、ローカルプロキシの稼働状況とすぐに使えるローカル API エンドポイントを確認できます。
|
||
|
||
- CLIProxyAPI コアの起動、停止、再起動、状態更新。
|
||
- インストール状態、実行状態、プロセス ID、コアバージョン、アプリバージョンの確認。
|
||
- OpenAI、Claude、Gemini 互換の API エンドポイントをそのままコピー。
|
||
- ローカル接続状態の確認。
|
||
|
||
コアのインストール、バージョン比較、オフラインインストールは **バージョン管理** ページで行えます。GitHub 公式、GitCode、GitHub ミラープロキシを切り替えたり、カスタム HTTPS ミラープレフィックスを追加したりできます。更新に失敗した場合は自動的に別の利用可能なソースへ切り替わります。
|
||
|
||
### OAuth アカウント認証
|
||
|
||
|
||
|
||
OAuth 画面では、対応プロバイダーのブラウザー認証をまとめて管理できます。
|
||
|
||
- Codex OAuth
|
||
- Claude OAuth
|
||
- Antigravity OAuth
|
||
- Kimi OAuth
|
||
- xAI OAuth
|
||
|
||
EasyCLIProxyAPI はブラウザーで認証ページを開きます。自動リダイレクトが利用できない場合は、
|
||
コールバックを手動で完了することもできます。
|
||
|
||
### API 接続とプロバイダー統合
|
||
|
||
|
||
|
||
API 接続画面では、プロトコルまたはプロバイダーごとに上流 API の認証情報と接続先を管理できます。
|
||
|
||
- Codex
|
||
- OpenAI 互換プロバイダー
|
||
- DeepSeek
|
||
- Claude
|
||
- Gemini
|
||
|
||
複数の接続設定を追加し、既存設定の検索、プロバイダー状態の更新、ヘルスチェックを行えます。すべての接続は、
|
||
統一されたローカル CLIProxyAPI エンドポイントから利用できます。リクエストとレスポンスは、
|
||
OpenAI、Claude、Gemini、およびその他の互換形式の間で変換できます。
|
||
|
||
### 使用履歴と Token 統計
|
||
|
||
|
||
|
||
使用履歴画面では、ローカルで発生したリクエストと Token 消費を確認できます。
|
||
|
||
- リクエスト総数、Token 総量、成功率、TPS、キャッシュヒット率、推定コストを確認。
|
||
- 時間、モデル、プロバイダー、ソース、キー、結果でデータを絞り込み。
|
||
- リクエストと Token の推移、入力・出力・推論・キャッシュの使用量を確認。
|
||
- リクエスト詳細、分析画面、価格統計を閲覧。
|
||
- CPA のリアルタイム使用量購読と永続ローカル inbox で収集し、購読できない場合は HTTP に自動フォールバック。
|
||
- 起動時に旧使用履歴データベースを一度だけ移行し、移行前のバックアップを `usage-records/backups` に保存。
|
||
|
||
### エージェントクライアント設定
|
||
|
||
|
||
|
||
エージェント画面は、インストール済みのデスクトップクライアントと CLI クライアントを検出し、
|
||
ローカルプロキシへの接続を支援します。対応クライアントは次のとおりです。
|
||
|
||
- Claude Code
|
||
- Claude Desktop
|
||
- Codex
|
||
- OpenCode
|
||
- OpenClaw
|
||
- Hermes Agent
|
||
- Pi（CLIProxyAPI provider 拡張機能）
|
||
- ZCode
|
||
- Kimi Code
|
||
- Grok Build
|
||
|
||
対応クライアントでは、利用可能なモデルカタログの同期、デフォルトモデルの選択、管理設定を適用する前の
|
||
元設定のバックアップ、以前の設定への復元、利用可能なデスクトップまたは 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 プロバイダーを設定します。
|
||
|
||
## アップグレード
|
||
|
||
すべての Windows リリースで、完全版 ZIP と旧クライアント互換の `update` ZIP を同時に公開します。まだ移行できていない旧クライアントでもアプリ内更新を利用でき、新しいクライアントでは内蔵 core も更新できる完全版パッケージを使用します。
|
||
|
||
現在の Windows、Linux、macOS リリースはアプリ内自動更新に対応しています。Linux では実行時データを保持したままポータブルアプリのファイルを置き換え、macOS では署名済みアプリバンドル全体を置き換えます。新しいバージョンの起動確認に失敗した場合は自動的にロールバックします。インストール先は現在のユーザーが書き込める必要があります。
|
||
|
||
既存の Linux および macOS インストールでは、クロスプラットフォーム自動更新マーカーを含むリリースへ一度手動で更新する必要があります。そのリリースを起動した後は、以降の更新をアプリ内で実行できます。
|
||
|
||
v0.2.5 以前を使用している場合は、一度だけ手動で移行してください。EasyCLIProxyAPI を終了し、使用中のアーキテクチャに対応する最新版の完全版 Windows ZIP をダウンロードして、その最上位ディレクトリの内容を既存のインストール先へコピーし、同名ファイルを上書きします。既存のディレクトリを先に削除しないでください。`config.toml`、`oauth`、`cpa-core/config.yaml` などのユーザーデータは保持されます。新しいバージョンを起動した後は、以降のリリースでアプリ内自動更新を利用できます。
|
||
|
||
## 対応プラットフォーム
|
||
|
||
GitHub Actions では、次のリリースパッケージをビルドします。
|
||
|
||
| OS | アーキテクチャ | 形式 |
|
||
| --- | --- | --- |
|
||
| Windows | amd64、aarch64 | ZIP |
|
||
| macOS | amd64、aarch64 | DMG |
|
||
| Linux | amd64、aarch64 | TAR.GZ |
|
||
|
||
## 関連プロジェクト
|
||
|
||
- [CLIProxyAPI](https://github.com/router-for-me/CLIProxyAPI) — 本アプリケーションが管理するプロキシコアです。
|