基于 C# / .NET / Avalonia 打造的新一代 LoCyanFrp 桌面客户端。
- 统一工作台:登录、刷新令牌、签到、账号统计集中管理。
- 隧道全生命周期:创建/修改/启动/停止/删除/批量操作一站式完成。
- frpc 集成管理:自动识别平台并下载匹配的 frpc 版本,校验后即可使用。
- 可视化面板:内置流量监控、节点状态、Minecraft 服务状态等仪表板。
- Fluent UI 体验:明暗主题切换、自定义标题栏,兼顾键鼠与触控。
- 崩溃防护:异常拦截、日志与调试工具,快速定位问题。
- 打开仓库的 Releases 页面。
- 根据平台下载最新压缩包(Windows/macOS/Linux)。
- 解压后运行
Kairo(或对应平台的可执行文件)。 - 首次启动会提示登录 LoCyanFrp 或输入访问密钥。
依赖 .NET SDK 10.0 与 git。
git clone https://github.com/Shiroiame-Kusu/Kairo.git
cd Kairo
dotnet restore Kairo.sln
dotnet run --project Kairo/Kairo.csproj --configuration Release生成自包含包:
dotnet publish Kairo/Kairo.csproj -c Release -r win-x64 --self-contained true构建过程中会使用 Avalonia 11、FluentAvaloniaUI,并执行
Components/BuildInfo.sh。请确保脚本具备可执行权限(chmod +x)。
- 账号与鉴权:账号密码登录、刷新令牌、获取访问密钥。
- 签到与福利:签到、查看流量数据。
- 隧道管理:支持创建、复制、更新、删除、启停及批量更新。
- 节点工具:节点连通性测试、域名列表、随机端口申请、统计信息查询。
- frpc 生命周期:下载指定版本、校验文件。
- CLI 模式:支持在无图形界面的 Linux 服务器上运行(详见下方)。
Kairo 提供独立的 CLI 版本 (kairo-cli),用于在没有图形界面的环境(如 Linux 服务器、Docker 容器、SSH 会话)中运行。
# 显示帮助
kairo-cli --help
# 显示版本信息
kairo-cli --version
# 获取 OAuth 授权 URL(首次使用)
kairo-cli --oauth
# 使用 Refresh Token 登录
kairo-cli --refresh-token <your_token>
# 列出所有隧道
kairo-cli --list
# 启动指定隧道
kairo-cli --proxy 123,456
# 指定 frpc 路径和 FRP Token
kairo-cli --frpc-path /path/to/frpc --frp-token <token> --proxy 123- 运行
kairo-cli --oauth获取授权 URL - 在浏览器中打开 URL 并完成授权
- 复制页面显示的 Refresh Token
- 运行
kairo-cli --refresh-token <token>完成登录 - 运行
kairo-cli启动隧道(会自动下载 frpc)
KAIRO_CONFIG_DIR:自定义配置文件目录路径
- 所有 API 与流程文档位于
docs/(中文)。示例:docs/获取隧道列表.md:查询并检查隧道状态。docs/创建隧道.md:新建并配置隧道流程。docs/创建 Minecraft 联机房间.md:通过 LoCyanFrp 搭建 Minecraft 房间。docs/鉴权说明.md/docs/鉴权验证流程.md:鉴权模式与流程。
- 欢迎 PR 协助翻译或补充文档。
Kairo/:Avalonia UI 主程序(App.axaml、MainWindow、Components、Utils 等)。Legacy/:历史 WPF 客户端,保留参考。Updater/:独立更新器项目。docs/:用户及 API 文档(中文)。logs/:运行/崩溃日志(不纳入版本控制)。
- Fork 仓库并从
preview分支创建特性分支。 - UI 变更需兼容明暗主题,并更新相关文档/截图。
- 提交前执行
dotnet format(或等效分析器)。 - 提交 PR 时请描述动机、影响范围及截图(如涉及界面)。
Bug 反馈、功能需求、翻译协助均可通过 GitHub Issues 提交。
项目以 GNU General Public License v3.0 开源,详情参见根目录 LICENSE。
