Update README: Rename project to flutter_opencode_client and add OpenCode documentation
Some checks failed
flutter analysis / check (push) Has been cancelled
Some checks failed
flutter analysis / check (push) Has been cancelled
This commit is contained in:
109
README.md
109
README.md
@@ -1,20 +1,29 @@
|
||||
English | [简体中文](README_zh.md)
|
||||
|
||||
<h2 align="center">Flutter Server Box</h2>
|
||||
<h2 align="center">Flutter OpenCode Client</h2>
|
||||
|
||||
<div align="center">
|
||||
<a href="https://cdn.lpkt.cn/donate"><img alt="donate" src="https://img.shields.io/badge/donate-me-pink"></a>
|
||||
<a href="https://git.wqyblog.cn/wuqiyang312/flutter_opencode_client"><img alt="repo" src="https://img.shields.io/badge/repo-opencode-blue"></a>
|
||||
<img alt="lang" src="https://img.shields.io/badge/lang-dart-cyan">
|
||||
<img alt="license" src="https://img.shields.io/badge/license-AGPLv3-yellow">
|
||||
<a href="https://deepwiki.com/lollipopkit/flutter_server_box"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
A Flutter project which provides charts to display Linux, Unix and Windows server status and tools to manage servers.
|
||||
<br>
|
||||
A Flutter project based on <a href="https://github.com/lollipopkit/flutter_server_box">ServerBox</a>, providing charts to display Linux, Unix and Windows server status and tools to manage servers.
|
||||
<br><br>
|
||||
<b>New Feature:</b> Integrated with <a href="https://opencode.ai">OpenCode</a> for SSH tunnel support and enhanced remote development capabilities.
|
||||
<br><br>
|
||||
Especially thanks to <a href="https://github.com/TerminalStudio/dartssh2">dartssh2</a> & <a href="https://github.com/TerminalStudio/xterm.dart">xterm.dart</a>.
|
||||
</p>
|
||||
|
||||
## 🆕 OpenCode Integration
|
||||
|
||||
This fork adds OpenCode (opencode.ai) integration via SSH tunnel, enabling:
|
||||
|
||||
- **Remote Development**: Connect to your servers through secure SSH tunnels
|
||||
- **AI-Powered Assistance**: Enhanced server management with AI capabilities
|
||||
- **Seamless Workflow**: Direct integration with OpenCode platform
|
||||
|
||||
## 🏙️ Screenshots
|
||||
|
||||
<table>
|
||||
@@ -28,61 +37,91 @@ Especially thanks to <a href="https://github.com/TerminalStudio/dartssh2">dartss
|
||||
|
||||
## 📥 Installation
|
||||
|
||||
|Platform| From|
|
||||
|--|--|
|
||||
| Platform | Source |
|
||||
|----------|--------|
|
||||
| Android | [GitHub Releases](https://github.com/lollipopkit/flutter_server_box/releases) / [F-Droid](https://f-droid.org/packages/tech.lolli.toolbox) |
|
||||
| iOS / macOS | [AppStore](https://apps.apple.com/app/id1586449703) |
|
||||
| Android | [GitHub](https://github.com/lollipopkit/flutter_server_box/releases) / [CDN](https://cdn.lpkt.cn/serverbox/pkg/?sort=time&order=desc&layout=grid) / [F-Droid](https://f-droid.org/packages/tech.lolli.toolbox) / [OpenAPK](https://www.openapk.net/serverbox/tech.lolli.toolbox/) |
|
||||
| Linux / Windows | [GitHub](https://github.com/lollipopkit/flutter_server_box/releases) / [CDN](https://cdn.lpkt.cn/serverbox/pkg/?sort=time&order=desc&layout=grid) |
|
||||
| Linux / Windows | [GitHub Releases](https://github.com/lollipopkit/flutter_server_box/releases) |
|
||||
|
||||
**Custom Build:**
|
||||
```bash
|
||||
git clone ssh://git@git.wqyblog.cn:2222/wuqiyang312/flutter_opencode_client.git
|
||||
cd flutter_opencode_client
|
||||
flutter build apk --release
|
||||
```
|
||||
|
||||
Please only download pkgs from the source that **you trust**!
|
||||
|
||||
## 🔖 Features
|
||||
|
||||
- `Status chart` (CPU, Sensors, GPU...), `SSH` Term, `SFTP`, `Docker & Process & Systemd`, `S.M.A.R.T`...
|
||||
- Platform specific: `Bio auth`、`Msg push`、`Home widget`、`watchOS App`...
|
||||
- English, 简体中文; Deutsch [@its-tom](https://github.com/its-tom), 繁體中文 [@kalashnikov](https://github.com/kalashnikov), Indonesian [@azkadev](https://github.com/azkadev), Français [@FrancXPT](https://github.com/FrancXPT), Dutch [@QazCetelic](https://github.com/QazCetelic), Türkçe [@mikropsoft](https://github.com/mikropsoft), Українська мова [@CakesTwix](https://github.com/CakesTwix); Español, Русский язык, Português, 日本語 (Generated by GPT)
|
||||
- **OpenCode Integration**: SSH tunnel support for remote development
|
||||
- Platform specific: `Bio auth`, `Msg push`, `Home widget`, `watchOS App`...
|
||||
- Multiple languages: English, 简体中文, Deutsch, 繁體中文, Indonesian, Français, Dutch, Türkçe, Українська мова, Español, Русский язык, Português, 日本語
|
||||
|
||||
## 🔧 Build from Source
|
||||
|
||||
### Requirements
|
||||
- Flutter SDK 3.29+
|
||||
- Dart 3.11+
|
||||
- Android SDK (for Android builds)
|
||||
- Java 17
|
||||
|
||||
### Quick Build
|
||||
```bash
|
||||
# Using the provided build script
|
||||
./build_apk.sh
|
||||
|
||||
# Or manually
|
||||
flutter pub get
|
||||
flutter build apk --release
|
||||
```
|
||||
|
||||
The APK will be generated at `build/app/outputs/flutter-apk/app-release.apk`
|
||||
|
||||
## 🆘 Help
|
||||
|
||||
<div align="center">
|
||||
<a href="https://qm.qq.com/q/daCGa7eShG"><img alt="qq" src="https://img.shields.io/badge/QQ-Group-pink"></a>
|
||||
<a href="https://t.me/lpktg"><img alt="donate" src="https://img.shields.io/badge/Telegram-lpktg-green"></a>
|
||||
<a href="https://discord.gg/SsVNbRhK7w"><img alt="discord" src="https://img.shields.io/badge/Discord-lpkt-purple"></a>
|
||||
</div>
|
||||
- For server status push functionality, install [ServerBoxMonitor](https://github.com/lollipopkit/server_box_monitor) on your servers
|
||||
- See [wiki](https://github.com/lollipopkit/server_box_monitor/wiki) for configuration details
|
||||
- **Common issues**: [app wiki](https://github.com/lollipopkit/flutter_server_box/wiki)
|
||||
|
||||
- In order to push server status to your portable device without opening ServerBox app (Such as **message push** and **home widget**), you need to install [ServerBoxMonitor](https://github.com/lollipopkit/server_box_monitor) on your servers, and config it correctly. See [wiki](https://github.com/lollipopkit/server_box_monitor/wiki) for more details.
|
||||
- **Common issues** can be found in [app wiki](https://github.com/lollipopkit/flutter_server_box/wiki).
|
||||
|
||||
Before you open an issue, please read the following:
|
||||
|
||||
1. Paste the **entire log** (click the top right of the home page) in the issue template.
|
||||
2. Make sure whether the issue is caused by ServerBox app.
|
||||
3. Welcome all valid and positive feedback, subjective feedback (such as you think other UI is better) may not be accepted.
|
||||
|
||||
After you read the above, you can open an [issue](https://github.com/lollipopkit/flutter_server_box/issues/new).
|
||||
Before opening an issue:
|
||||
1. Paste the **entire log** (click the top right of the home page)
|
||||
2. Verify the issue is caused by the app
|
||||
3. Welcome valid and positive feedback
|
||||
|
||||
## 🧱 Contributions
|
||||
|
||||
Any positive contribution is welcome.
|
||||
|
||||
If I forgot to add your name to the contributors list, please add a comment in the issue or PR you opened to let me know, I will add it as soon as possible.
|
||||
|
||||
### Development
|
||||
|
||||
1. Setup [Flutter](https://flutter.dev/docs/get-started/install) environment.
|
||||
2. Clone this repo, run `flutter run` to start the app.
|
||||
3. Run `dart run fl_build -p PLATFORM` to build the app.
|
||||
1. Setup [Flutter](https://flutter.dev/docs/get-started/install) environment
|
||||
2. Clone this repo: `git clone ssh://git@git.wqyblog.cn:2222/wuqiyang312/flutter_opencode_client.git`
|
||||
3. Run `flutter run` to start the app
|
||||
4. Run `dart run fl_build -p PLATFORM` to build
|
||||
|
||||
### Translation
|
||||
- See [Guide](https://blog.lpkt.cn/posts/faq/)
|
||||
- Feel free to open a PR
|
||||
|
||||
- [Guide](https://blog.lpkt.cn/posts/faq/) can be found in my blog.
|
||||
- We need your help! Just feel free to open a PR.
|
||||
## 📁 Repositories
|
||||
|
||||
## 💡 My other apps
|
||||
- **Main Repository**: `ssh://git@git.wqyblog.cn:2222/wuqiyang312/flutter_opencode_client.git`
|
||||
- **Upstream**: [lollipopkit/flutter_server_box](https://github.com/lollipopkit/flutter_server_box)
|
||||
|
||||
- [GPT Box](https://github.com/lollipopkit/flutter_gpt_box) - A third-party GPT Client for OpenAI API on all platforms.
|
||||
## 💡 Original Apps
|
||||
|
||||
- [ServerBox](https://github.com/lollipopkit/flutter_server_box) - Original server management app
|
||||
- [GPT Box](https://github.com/lollipopkit/flutter_gpt_box) - OpenAI API client
|
||||
- [More](https://github.com/lollipopkit) - Tools & etc.
|
||||
|
||||
## 📝 License
|
||||
|
||||
`AGPL v3 lollipopkit & all contributors`
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<i>Forked from ServerBox with OpenCode integration</i>
|
||||
</p>
|
||||
|
||||
122
README_zh.md
122
README_zh.md
@@ -1,20 +1,29 @@
|
||||
简体中文 | [English](README.md)
|
||||
|
||||
<h2 align="center">Flutter Server Box</h2>
|
||||
<h2 align="center">Flutter OpenCode Client</h2>
|
||||
|
||||
<div align="center">
|
||||
<a href="https://cdn.lpkt.cn/donate"><img alt="donate" src="https://img.shields.io/badge/捐赠-我-pink"></a>
|
||||
<a href="https://git.wqyblog.cn/wuqiyang312/flutter_opencode_client"><img alt="仓库" src="https://img.shields.io/badge/仓库-opencode-blue"></a>
|
||||
<img alt="语言" src="https://img.shields.io/badge/语言-dart-cyan">
|
||||
<img alt="license" src="https://img.shields.io/badge/证书-AGPLv3-yellow">
|
||||
<a href="https://deepwiki.com/lollipopkit/flutter_server_box"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
使用 Flutter 开发的 Linux, Unix, Windows 服务器工具箱,提供服务器状态图表和管理工具。
|
||||
<br>
|
||||
基于 <a href="https://github.com/lollipopkit/flutter_server_box">ServerBox</a> 开发的 Flutter 服务器工具箱,提供 Linux、Unix、Windows 服务器状态图表和管理工具。
|
||||
<br><br>
|
||||
<b>新特性:</b>集成 <a href="https://opencode.ai">OpenCode</a>,支持 SSH 隧道和增强的远程开发能力。
|
||||
<br><br>
|
||||
特别感谢 <a href="https://github.com/TerminalStudio/dartssh2">dartssh2</a> & <a href="https://github.com/TerminalStudio/xterm.dart">xterm.dart</a>。
|
||||
</p>
|
||||
|
||||
## 🆕 OpenCode 集成
|
||||
|
||||
此分支添加了 OpenCode (opencode.ai) 集成功能,通过 SSH 隧道实现:
|
||||
|
||||
- **远程开发**:通过安全 SSH 隧道连接到你的服务器
|
||||
- **AI 驱动**:AI 能力增强的服务器管理
|
||||
- **无缝工作流**:与 OpenCode 平台直接集成
|
||||
|
||||
## 🏙️ 截屏
|
||||
|
||||
<table>
|
||||
@@ -28,62 +37,91 @@
|
||||
|
||||
## 📥 安装
|
||||
|
||||
平台|下载
|
||||
--|--
|
||||
iOS / macOS | [AppStore](https://apps.apple.com/app/id1586449703)
|
||||
Android | [GitHub](https://github.com/lollipopkit/flutter_server_box/releases) / [CDN](https://cdn.lpkt.cn/serverbox/pkg/?sort=time&order=desc&layout=grid) / [F-Droid](https://f-droid.org/packages/tech.lolli.toolbox) / [OpenAPK](https://www.openapk.net/serverbox/tech.lolli.toolbox/)
|
||||
Linux / Windows | [GitHub](https://github.com/lollipopkit/flutter_server_box/releases) / [CDN](https://cdn.lpkt.cn/serverbox/pkg/?sort=time&order=desc&layout=grid)
|
||||
| 平台 | 下载源 |
|
||||
|------|--------|
|
||||
| Android | [GitHub](https://github.com/lollipopkit/flutter_server_box/releases) / [F-Droid](https://f-droid.org/packages/tech.lolli.toolbox) |
|
||||
| iOS / macOS | [AppStore](https://apps.apple.com/app/id1586449703) |
|
||||
| Linux / Windows | [GitHub](https://github.com/lollipopkit/flutter_server_box/releases) |
|
||||
|
||||
**自定义构建:**
|
||||
```bash
|
||||
git clone ssh://git@git.wqyblog.cn:2222/wuqiyang312/flutter_opencode_client.git
|
||||
cd flutter_opencode_client
|
||||
flutter build apk --release
|
||||
```
|
||||
|
||||
请从 **信任** 的来源下载!
|
||||
|
||||
## 🔖 特点
|
||||
|
||||
- `状态图表`(CPU、传感器、GPU 等), `SSH` 终端, `SFTP`, `Docker & 进程 & Systemd` 管理,`S.M.A.R.T`...
|
||||
- 特殊支持:`生物认证`、`推送`、`桌面小部件`、`watchOS App`、`跟随系统颜色`...
|
||||
- 本地化
|
||||
- English, 简体中文
|
||||
- Español, Русский язык, Português, 日本語 (Generated by GPT)
|
||||
- Deutsch [@its-tom](https://github.com/its-tom), 繁體中文 [@kalashnikov](https://github.com/kalashnikov), Indonesian [@azkadev](https://github.com/azkadev), Français [@FrancXPT](https://github.com/FrancXPT), Dutch [@QazCetelic](https://github.com/QazCetelic), Türkçe [@mikropsoft](https://github.com/mikropsoft), Українська мова [@CakesTwix](https://github.com/CakesTwix);
|
||||
- 感谢贡献者们!
|
||||
- `状态图表`(CPU、传感器、GPU 等)、`SSH` 终端、`SFTP`、`Docker & 进程 & Systemd` 管理、`S.M.A.R.T`...
|
||||
- **OpenCode 集成**:SSH 隧道支持远程开发
|
||||
- 特殊支持:`生物认证`、`推送`、`桌面小部件`、`watchOS App`...
|
||||
- 多语言:English、简体中文、Deutsch、繁體中文、Indonesian、Français、Dutch、Türkçe、Українська мова、Español、Русский язык、Português、日本語
|
||||
|
||||
## 🔧 从源码构建
|
||||
|
||||
### 环境要求
|
||||
- Flutter SDK 3.29+
|
||||
- Dart 3.11+
|
||||
- Android SDK(用于 Android 构建)
|
||||
- Java 17
|
||||
|
||||
### 快速构建
|
||||
```bash
|
||||
# 使用提供的构建脚本
|
||||
./build_apk.sh
|
||||
|
||||
# 或手动构建
|
||||
flutter pub get
|
||||
flutter build apk --release
|
||||
```
|
||||
|
||||
APK 将生成在 `build/app/outputs/flutter-apk/app-release.apk`
|
||||
|
||||
## 🆘 帮助
|
||||
|
||||
<div align="center">
|
||||
<a href="https://qm.qq.com/q/daCGa7eShG"><img alt="qq" src="https://img.shields.io/badge/QQ-群-pink"></a>
|
||||
<a href="https://t.me/lpktg"><img alt="donate" src="https://img.shields.io/badge/Telegram-lpktg-green"></a>
|
||||
<a href="https://discord.gg/SsVNbRhK7w"><img alt="discord" src="https://img.shields.io/badge/Discord-lpkt-purple"></a>
|
||||
</div>
|
||||
- 如需服务器状态推送功能,请在服务器上安装 [ServerBoxMonitor](https://github.com/lollipopkit/server_box_monitor)
|
||||
- 配置详情参见 [wiki](https://github.com/lollipopkit/server_box_monitor/wiki)
|
||||
- **常见问题**:[app wiki](https://github.com/lollipopkit/flutter_server_box/wiki)
|
||||
|
||||
- 为了可以在不使用 ServerBox app 时获取服务器状态(例如:桌面小部件、推送服务),你需要在你的服务器上安装 [ServerBoxMonitor](https://github.com/lollipopkit/server_box_monitor),详情见 [wiki](https://github.com/lollipopkit/server_box_monitor/wiki/%E4%B8%BB%E9%A1%B5)。
|
||||
- **常见问题** 可以在 [app wiki](https://github.com/lollipopkit/flutter_server_box/wiki/主页) 查看。
|
||||
|
||||
反馈前须知:
|
||||
|
||||
1. 反馈问题请附带 log(点击首页右上角),并以 bug 模版提交。
|
||||
2. 反馈问题前请检查是否是 serverbox 的问题。
|
||||
3. 欢迎所有有效、正面的反馈,主观(比如你觉得其他UI更好看)的反馈不一定会接受
|
||||
提交 issue 前:
|
||||
1. 粘贴 **完整日志**(点击首页右上角)
|
||||
2. 确认问题是由应用引起的
|
||||
3. 欢迎有效和积极的反馈
|
||||
|
||||
## 🧱 贡献
|
||||
|
||||
任何正面的贡献都欢迎。
|
||||
|
||||
如果我忘记在贡献者列表中添加你的名字,请在你打开的 issue 或 PR 中添加评论让我知道,我会尽快添加。
|
||||
欢迎任何积极的贡献。
|
||||
|
||||
### 开发
|
||||
|
||||
1. 安装 [Flutter](https://flutter.dev/docs/get-started/install)
|
||||
2. 克隆这个仓库, 运行 `flutter run` 启动应用
|
||||
3. 运行 `dart run fl_build -p PLATFORM` 构建应用
|
||||
1. 安装 [Flutter](https://flutter.dev/docs/get-started/install) 环境
|
||||
2. 克隆仓库:`git clone ssh://git@git.wqyblog.cn:2222/wuqiyang312/flutter_opencode_client.git`
|
||||
3. 运行 `flutter run` 启动应用
|
||||
4. 运行 `dart run fl_build -p PLATFORM` 构建
|
||||
|
||||
### 翻译
|
||||
- 参见 [指南](https://blog.lpkt.cn/posts/faq/)
|
||||
- 欢迎提交 PR
|
||||
|
||||
[指南](https://blog.lpkt.cn/faq/) 可在我的博客中找到。
|
||||
## 📁 仓库
|
||||
|
||||
## 💡 我的其它 Apps
|
||||
- **主仓库**: `ssh://git@git.wqyblog.cn:2222/wuqiyang312/flutter_opencode_client.git`
|
||||
- **上游项目**: [lollipopkit/flutter_server_box](https://github.com/lollipopkit/flutter_server_box)
|
||||
|
||||
- [GPT Box](https://github.com/lollipopkit/flutter_gpt_box) - 支持 OpenAI API 的 第三方全平台客户端。
|
||||
- [更多](https://github.com/lollipopkit) - 工具 & etc.
|
||||
## 💡 原应用
|
||||
|
||||
## 📝 协议
|
||||
- [ServerBox](https://github.com/lollipopkit/flutter_server_box) - 原版服务器管理应用
|
||||
- [GPT Box](https://github.com/lollipopkit/flutter_gpt_box) - OpenAI API 客户端
|
||||
- [More](https://github.com/lollipopkit) - 工具等
|
||||
|
||||
`AGPL v3 lollipopkit & 所有贡献者`
|
||||
## 📝 证书
|
||||
|
||||
`AGPL v3 lollipopkit & all contributors`
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<i>Fork 自 ServerBox,集成 OpenCode 功能</i>
|
||||
</p>
|
||||
|
||||
Reference in New Issue
Block a user