Skip to content

QwenVorTex/CLIProxyAPI-Control-Panel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CPA Control Panel

面向 CLIProxyAPI 的非官方 Windows 原生控制面板,使用 Rust + Slint 构建。

本项目不是 CLIProxyAPI 官方项目,也不隶属于上游维护者。它不包含、修改或重新编译原始 CLIProxyAPI;使用前请自行安装上游程序,并遵守其许可证与使用条款。

特性

  • 原生 Windows x64 桌面程序:双击启动,无浏览器界面、无需 Node 或命令行启动。
  • Apple 风格浅色界面,支持圆角窗口、拖动、缩放、最小化、最大化和关闭。
  • 支持 Windows Per-Monitor V2 DPI;适配高分辨率和 Windows 自定义缩放。
  • 在一个面板中查看、启动与关闭本机 CPA 服务。
  • 直接调用 CPA 的 Codex 登录流程,并自动刷新本机 OAuth 凭据状态。
  • 读取、生成、显示、复制和保存代理 API Key。
  • 提供常用设置与诊断日志;日志会自动遮盖 API Key、Bearer token、管理密钥和 OAuth 敏感值。
  • 配置保存采用最小范围修改,保留 config.yaml 中未由面板管理的字段与注释。

系统要求

  • Windows 10 或 Windows 11 x64。
  • 已安装并完成基础配置的 CLIProxyAPI
  • 控制面板与 cli-proxy-api.execonfig.yaml 位于同一安装目录层级。

安装与启动

  1. CLIProxyAPI Releases 下载并完成上游程序的安装与配置。

  2. 从本项目的 Releases 下载 CPAControlPanel.exe

  3. 将该 EXE 放入 CLIProxyAPI 安装目录的 control-panel 文件夹:

    CLIProxyAPI/
    ├─ cli-proxy-api.exe
    ├─ config.yaml
    └─ control-panel/
       └─ CPAControlPanel.exe
    
  4. 双击 CPAControlPanel.exe

程序会从父目录定位 cli-proxy-api.execonfig.yaml。请不要把原始 CPA EXE 放到桌面或复制到控制面板目录。

使用说明

总览

  • 查看 CPA 是否运行、监听地址、进程 PID、主机和 API Key 数量。
  • 点击“启动 CPA”启动与当前安装路径完全匹配的上游程序。
  • 服务运行时可以点击“关闭 CPA”;面板不会关闭不属于当前安装路径的同名进程。

Codex 账户

  • 点击“添加 Codex 账户”启动 CPA 的 Codex 认证流程。
  • 按浏览器中打开的官方授权页完成登录;登录结束后返回面板,凭据列表会自动刷新。
  • “本机管理连接”是可选功能。只有你主动初始化管理密钥时,面板才会写入 remote-management.secret-key

API Key 与常用设置

  • API Key 会从 config.yamlapi-keys 中读取;保存时仅更新第一项。
  • 生成新 Key 后请同步更新你的客户端配置。
  • “常用设置”只管理面板明确显示的字段。TLS、插件、供应商映射和远程管理开放状态仍请直接在 config.yaml 中维护。

诊断日志

  • 用于查看控制面板、CPA 与认证流程相关的本机事件。
  • 页面展示前会脱敏常见密钥与令牌;仍请避免在截图、Issue 或日志中贴出完整凭据。

安全与边界

  • 不要将 config.yaml、OAuth 凭据、API Key、管理密钥或诊断日志提交到 GitHub。
  • 不要在公开 Issue、截图或讨论中暴露完整 Token / Key。
  • 本项目不捆绑 CLIProxyAPI 二进制文件;请从上游官方 Releases 获取。
  • 运行控制面板不会修改原始 cli-proxy-api.exe

从源码构建

前置条件

  • Rust 1.88(MSVC 工具链)
  • Visual Studio 2022 C++ Build Tools

构建与测试

cargo build --release --locked
cargo test --locked

发布产物位于:

target\release\cpa-control-panel.exe

发布时可将其重命名为 CPAControlPanel.exe,作为 GitHub Release 附件上传。建议同时附上 SHA-256 校验值;不要把编译产物长期提交进源码分支。

发布到 GitHub

建议在仓库 About 中填写:

Unofficial native Windows control panel for CLIProxyAPI, built with Rust + Slint.
  • Homepagehttps://github.com/router-for-me/CLIProxyAPI
  • Topicsrustslintwindowsdesktopcli-proxy-apicodex
  • 使用 GitHub Releases 发布 CPAControlPanel.exe 与 SHA-256 校验值。

上游与许可证

  • 上游项目:router-for-me/CLIProxyAPI
  • 上游仓库标注为 MIT License;请在分发任何上游文件或资产前核对其最新许可证要求。
  • 本仓库暂未附带自身许可证文件。公开发布前,请根据你的发布意图添加合适的 LICENSE;不要因为上游采用 MIT 就默认替本项目选择许可证。

致谢

感谢 CLIProxyAPI 及其贡献者提供上游服务能力。本项目仅提供本机桌面控制面板体验。

About

Unofficial native Windows control panel for CLIProxyAPI, built with Rust + Slint.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors