128 lines
4.6 KiB
Markdown
128 lines
4.6 KiB
Markdown
English | [简体中文](README_zh.md)
|
|
|
|
<h2 align="center">Flutter OpenCode Client</h2>
|
|
|
|
<div align="center">
|
|
<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">
|
|
</div>
|
|
|
|
<p align="center">
|
|
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>
|
|
<tr>
|
|
<td><img width="200px" src="https://cdn.lpkt.cn/serverbox/screenshot/1.jpg"></td>
|
|
<td><img width="200px" src="https://cdn.lpkt.cn/serverbox/screenshot/2.jpg"></td>
|
|
<td><img width="200px" src="https://cdn.lpkt.cn/serverbox/screenshot/3.jpg"></td>
|
|
<td><img width="200px" src="https://cdn.lpkt.cn/serverbox/screenshot/4.jpg"></td>
|
|
</tr>
|
|
</table>
|
|
|
|
## 📥 Installation
|
|
|
|
| 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) |
|
|
|
|
**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`...
|
|
- **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
|
|
|
|
- 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)
|
|
|
|
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.
|
|
|
|
### Development
|
|
|
|
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
|
|
|
|
## 📁 Repositories
|
|
|
|
- **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)
|
|
|
|
## 💡 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>
|