Update README: Rename project to flutter_opencode_client and add OpenCode documentation

2026-04-03 19:11:18 +08:00
parent b9750b5ba3
commit dd31e01086
2 changed files with 156 additions and 79 deletions
--- a/README.md
+++ b/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|
-|--|--|
-| 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)                                                                                                                                 |
+| 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) |
+| Linux / Windows | [GitHub Releases](https://github.com/lollipopkit/flutter_server_box/releases) |

-Please only download pkgs from the source that **you trust**!  
+**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>