cross-platform-llm-client README

The project's README from github.com/orailnoor/cross-platform-llm-client. As one markdown file: README.md.

PrivateLM

Live Web App

A production-ready, cross-platform AI chat client built with Flutter. It unifies local on-device LLM inference (Android) with cloud API access, giving users full control over how their models run.

Image generation tested on Moto G71 (Snapdragon), Oneplus 10r (Mediatek), Pixel 6A (Tensor), Poco F1 (Snapdragon), Samsung s23 (Snapdragon) 4 steps fast Image generation tested on Moto G71 (Snapdragon), Oneplus 10r (Mediatek), Pixel 6A (Tensor), Poco F1 (Snapdragon), Samsung s23 (Snapdragon) 4 steps fast

Generated on pixel 6 with 20 step Generated on pixel 6 with 20 step

What It Does

Technical Architecture

Stack

Inference Pipeline

┌─────────────────────────────────────────────────────────────┐
│                        UI Layer                              │
│   ChatView / ModelView / ServerView / SettingsView          │
└──────────────────────────┬──────────────────────────────────┘
                           │
┌──────────────────────────▼──────────────────────────────────┐
│                    Controllers (GetX)                        │
│   ChatController · TaskController · ModelController         │
│   SettingsController · HomeController                       │
└──────────────────────────┬──────────────────────────────────┘
                           │
┌──────────────────────────▼──────────────────────────────────┐
│                      Services                                │
│  ┌─────────────────┐  ┌─────────────────┐  ┌─────────────┐ │
│  │ InferenceService│  │  CloudService   │  │DownloadSvc  │ │
│  │  (local GGUF)   │  │ (OpenAI/Claude/ │  │ (model dl)  │ │
│  │                 │  │  Gemini/Kimi)   │  │             │ │
│  └─────────────────┘  └─────────────────┘  └─────────────┘ │
│  ┌─────────────────┐  ┌─────────────────┐  ┌─────────────┐ │
│  │  HiveService    │  │ DeviceInfoSvc   │  │ExecutionSvc │ │
│  │  ( persistence) │  │  (RAM/GPU tier) │  │ (bg tasks)  │ │
│  └─────────────────┘  └─────────────────┘  └─────────────┘ │
└─────────────────────────────────────────────────────────────┘

Local Inference (Android)

The app uses llama_flutter_android, a custom Flutter plugin wrapping llama.cpp for ARM64 devices. At runtime it:

  1. Detects GPU capabilities via Vulkan to determine offload layers.
  2. Selects thread count based on device tier (ultra / high / mid / low).
  3. Loads the GGUF model with progress streaming.
  4. Generates tokens via generateChat() with native chat-template support (ChatML, Llama-3, Gemma, Phi).
  5. Falls back to manual prompt construction if native templates fail.

Idle detection (5s) and hard timeouts (180s) keep the UX responsive even on underpowered hardware.

Cloud Inference

CloudService normalizes four different API shapes into a single interface:

API keys are stored in Hive and never transmitted anywhere except to the provider's endpoint.

Cross-Platform Abstraction

Local inference is conditionally compiled:

The InferenceService exposes supportsLocalInference so the UI can hide local-model UI on unsupported platforms.

Supported Platforms

Platform Local Inference Cloud APIs Notes
Android ✅ Yes ✅ Yes CPU offload via NEON; minSdk 28
iOS ✅ Yes ✅ Yes Metal GPU acceleration
Web ❌ No ✅ Yes Cloud-only (local coming soon)

iOS / iPad (Installation via AltServer)

The iOS/iPad release is distributed as a sideloadable IPA file. Due to the RAM requirements for local models, iPad is the recommended iOS target, but it can be installed on iPhones.

Here is how you can install the app using AltStore and AltServer:

Prerequisites:

Installation Steps:

  1. Download the IPA: Go to the Releases page on your iOS device (using Safari) and download the latest PrivateLM-iOS.zip package, extract it to get the .ipa file.
  2. Open in AltStore:
    • Locate the extracted .ipa file in your device's "Files" app.
    • Tap the Share button and select AltStore from the list of apps.
    • Alternatively, you can open the AltStore app, go to the My Apps tab, tap the "+" (plus) icon in the top-left corner, and select the downloaded IPA file.
  3. Install: AltStore will begin installing the app. You may be prompted to enter your Apple ID credentials if this is your first time.
  4. Enable Developer Mode: On iOS 16 and later, ensure "Developer Mode" is enabled in your device's Settings (Settings > Privacy & Security > Developer Mode) to launch the sideloaded app.
  5. Launch: Once installation is finished, PrivateLM will appear in the My Apps tab in AltStore and on your device's home screen!

Note: Sideloaded apps via AltStore expire after 7 days, but AltStore will attempt to automatically refresh them in the background when connected to the same Wi-Fi as your computer running AltServer.

Build Configuration

Prerequisites

Android

flutter pub get
flutter build apk --debug

Release APKs require a stable signing key. Copy android/key.properties.example to android/key.properties, fill in the keystore values, and keep both the key and its backup. Android accepts an APK upgrade only when it is signed with the same key as the installed APK.

cp android/key.properties.example android/key.properties
flutter build apk --release --split-per-abi

Never rotate the signing key between GitHub releases. The per-ABI APKs must also keep increasing the build number in pubspec.yaml.

iOS

flutter pub get
cd ios
pod install
flutter build ios

Web

flutter pub get
flutter build web --release

License

MIT — see LICENSE for details.

cross-platform-llm-client (orailnoor/cross-platform-llm-client)

Searching Database…

1.6K ·GitHub
Cross-platform-llm-client
What is this?PrivateLM is a Flutter app for phones that chats with AI either on-device with GGUF models or through cloud APIs you choose.
Is it an app I install or a library I add to my code?It's an app you install, not a library. Android and iOS get full local inference, while the web version only talks to cloud APIs.
How do I get it on my phone?On Android, grab the APK from the Releases page. On iOS, download PrivateLM-iOS.zip, extract the .ipa, and install it with AltStore, which needs AltServer running on a Mac or Windows PC.
Do I need my own API key to use it?No, local models need nothing beyond the download. Cloud mode needs your own key for OpenAI, Anthropic, Google Gemini or Kimi, and those keys stay on the device.
What are the catches?The task view for multi-step workflows is still in development and not in the app yet. On iOS, AltStore sideloads expire after 7 days and must be refreshed over Wi-Fi with AltServer.
Which devices does it run on?Android and iOS both get local inference, and the web is cloud-only. The iPad is the recommended iOS target because local models need a lot of RAM, though it also installs on iPhones.
Can I send pictures to the model?Yes, you can send text and images in the same chat. Vision works with local Qwen2-VL models and with the cloud providers.
Does it adjust itself to my phone's memory?On first launch it checks your device's RAM and recommends a context size and token limits. For local inference it also picks a thread count based on device tier.
Which local model formats and chat templates are supported?Local models use the GGUF format. Native chat templates cover ChatML, Llama-3, Gemma and Phi, with manual prompt construction as a fallback.
What are similar projects?nobodywho, gpt4all, runanywhere-sdks, Portable-Local-Studio, stable-diffusion.cpp, inferssd, cardputer-ai, PS5LM
Which topics is it in?llama-cpp, on-device, dart, gguf, flutter, metal, vulkan, chat, gpu-acceleration, multimodal, local-llm, chatbot
Creator
orailnoor
Size
98.1 MB
Stars
1.6K
Updated
CommitNov 04Release1.0.7-clusterNov 04
Age
6mo
Commits · 90 Days