Skip to content

README.md

Latest commit

 

History

History
223 lines (169 loc) · 15.5 KB

README.md

File metadata and controls

223 lines (169 loc) · 15.5 KB
Raw

LeanType

LeanType Banner

Latest Release Downloads Stars License: GPL v3 Sponsor Donate on Open Collective

A private, smart, and deeply customizable open-source Android keyboard.
Forked from HeliBoard / OpenBoard / AOSP LatinIME.

Screenshots • Download APKs • Flavor Comparison • Features • Setup Guide • Ecosystem • Other Projects

🚀 Overview

LeanType combines the trusted, lightweight, privacy-focused foundation of HeliBoard with modern productivity features: Multi-Provider Cloud, Self-Hosted & Offline AI proofreading, On-Device Whisper Voice Typing, Handwriting Recognition, Smart Toolbar Auto-Spanning, Built-in Self-Updater, and Rich Text Tools, while keeping you in complete control over your data.

📸 Screenshots

Keyboard Main View AI Proofreading Clipboard Search Text Editing Panel Settings Screen Floating Keyboard

📦 Flavor Comparison

LeanType is available in 4 distinct flavors designed to match your exact privacy preferences, hardware specifications, and feature requirements:

Feature / Capability 🌟 Standard Full
-standardfull-release.apk		 🌿 Standard (FOSS)
-standard-release.apk		 🛡️ Offline AI
-offline-release.apk		 ⚡ Offline Lite
-offlinelite-release.apk
Target Audience Recommended for full feature set F-Droid / 100% Pure FOSS users Privacy purists wanting Local AI Minimalists wanting Zero AI
Cloud AI (Gemini, Groq, OpenAI) ✅ Yes ✅ Yes ❌ No ❌ No
Offline AI (Local GGUF via llama.cpp) ❌ No ❌ No ✅ Yes ❌ No
Translation (Offline & AI) ✅ Yes (Plugin, AI, or ML Kit) ✅ Yes (Plugin or AI) ✅ Yes (via Plugin) ✅ Yes (via Plugin)
Voice Typing (On-device Whisper) ✅ Yes (via plugin) ✅ Yes (via plugin) ✅ Yes (via plugin) ✅ Yes (via plugin)
Handwriting Input ✅ Yes (via plugin) ✅ Yes (via plugin) ✅ Yes (via plugin) ✅ Yes (via plugin)
In-App Self-Updater ✅ Yes (GitHub Releases) ❌ No (F-Droid managed) ❌ No ❌ No
Plugins & Models Setup In-app download or File import In-app download or File import Browser download + File import Browser download + File import
Internet Permission 🌐 Optional (Cloud AI/Updates) 🌐 Optional (Cloud AI) 🚫 None (OS-level blocked) 🚫 None (OS-level blocked)
Package ID com.leanbitlab.leantype com.leanbitlab.leantype com.leanbitlab.leantype.offline com.leanbitlab.leantype.offlinelite
Min Android Version Android 6.0+ (SDK 23) Android 6.0+ (SDK 23) Android 8.0+ (SDK 26) Android 5.0+ (SDK 21)
Approximate APK Size ~11 MB ~11 MB ~67 MB ~26 MB

Tip

APK Installation Notice: Google Play Protect or your browser may block direct APK installations downloaded from web browsers. If you experience installation issues, install via Obtainium or a package manager like App Manager.

✨ Features

🤖 AI Integration & Smart Tools

  • Multi-Provider Cloud & Self-Hosted AI: Integrated proofreading, grammar correction, and text rewriting powered by Google Gemini, Groq (Llama 3.3, Mixtral, DeepSeek), OpenAI, or any Self-Hosted local LLM server (Ollama, LM Studio, LocalAI, vLLM, or custom OpenAI-compatible endpoints).
  • Dynamic Model Fetching: Automatically fetches and populates the latest available model IDs directly from your cloud or self-hosted provider.
  • 🛡️ Offline Neural Proofreading (GGUF): Run compact, quantized GGUF language models directly on your device via embedded llama.cpp—100% private, zero network access (offline flavor).
  • 🌐 Multi-Mode In-Keyboard Translation: Translate text directly into any language without switching apps. Choose between Offline Translation Plugin (supported across all flavors), Built-in Offline Translation (ML Kit), or your configured Cloud / Self-Hosted AI Provider (Gemini, Groq, OpenAI, Ollama) with seamless fallback.
  • 🧠 Custom AI Keys & Capsules: Assign custom prompts, personas (#editor, #proofread), and themed tag capsules to 10 customizable toolbar keys.

🎙️ Voice & Handwriting Input

  • On-Device Whisper Voice Typing: High-accuracy speech recognition powered by compact quantized Whisper models via the LeanType Voice Plugin.
  • Interactive Voice Toolbar: Real-time waveform audio visualizer, silence detection sensitivity slider, and background keep-alive options.
  • ✍️ Handwriting Recognition: Draw characters or words directly on an expansive writing canvas using the LeanType Handwriting Plugin (supported across all flavors), with dedicated settings and in-app/offline model management.

⌨️ Layouts, Navigation & Typing

  • 👆 Gesture / Glide Typing: Smooth swipe typing powered by native C++ libraries (libjni_latinime.so).
  • 📐 Smart Auto-Spanning Toolbar: Dynamically expands and balances toolbar keys symmetrically to prevent awkward gaps across portrait, landscape, and tablet widths.
  • 🧭 Dedicated Text Editing Panel: Gboard-style precision DPAD arrow navigation, selection mode (Shift + arrows), select word, select all, and editing shortcuts.
  • 🖱️ Touchpad Mode: Swipe up on the spacebar to control the cursor freely across the screen, including full-screen laptop-style touchpad mode.
  • 🪟 Floating & Resizable Keyboard: Detach into a moveable floating window with persistent positioning for multitasking.
  • ⌨️ Dual Toolbar / Split Suggestions: Option to split suggestions from the quick-action toolbar.
  • 🎨 Custom Layout Profiles: Save up to 5 custom layout profiles with persistent slot index tracking.
  • ⌨️ Direct Switch Target IME: Bind keycode -10076 to any toolbar key to switch directly to a specific target keyboard (e.g. Japanese, Korean, or Chinese IME).

📋 Clipboard & Productivity

  • 🔍 Smart Clipboard History & Inline Editing: Search clips in real-time, swipe right to edit text directly in the toolbar with full gesture cursor/deletion, swipe left to delete with 5s undo, and fold pinned items.
  • 📸 Screenshot Suggestions: Detects recently taken screenshots and offers instant 1-tap sharing via the suggestion strip or clipboard history.
  • 📝 Versatile Text Expander: Built-in shortcut expansion with dynamic variables (%date%, %time%, %clipboard%, %cursor%), composable modifier filters (%clipboard:clean%, :singleline, :title, :slug, :upper, :replace), and automatic Wikipedia / research paper citation cleaner.
  • ✉️ Privacy-First OTP Auto-Fill: Notification-based OTP verification code detection without sensitive SMS permissions, with customizable messaging app selection.
  • 📚 Smart Learning & Session Boost: Adaptive personal dictionary learning threshold (1 to 5 times) and dynamic session word boosting.
  • 🚫 Blacklist & Regex Filtering: Filter offensive words or unwanted suggestions with custom regex pattern support.
  • 🔄 Google Dictionary Import: Seamlessly import personal dictionary words exported from Gboard.
  • 🔄 In-App Streaming Updater: Direct GitHub release checks and streaming APK self-updating with single-version changelogs (standardfull flavor).

📥 Download

Get it on GitHub Get it on Obtainium Get it on F-Droid

🛠️ Setup Guide

1. Cloud & Self-Hosted AI Setup (Gemini / Groq / OpenAI / Ollama)

  1. Cloud API: Obtain an API key from Google AI Studio or Groq Console.
  2. Self-Hosted AI: Run Ollama, LM Studio, or LocalAI on your local network (e.g. http://192.168.1.100:11434/v1).
  3. Open Settings → AI Integration → Set AI Provider.
  4. Select your provider (or choose Custom (OpenAI-compatible) for self-hosted instances), enter your endpoint URL/token, and choose your preferred model and target language.
  5. 👉 Read the Full AI & Prompts Guide

2. Voice Input Setup (Whisper AI)

  1. Install the companion LeanType Voice Plugin.
  2. Open Settings → Voice typing → Whisper Speech Models.
  3. Download or import your preferred Multilingual Whisper model (e.g. Tiny ~32 MB, Base ~57 MB, or Small ~182 MB supporting 99+ languages).
  4. Tap the microphone icon on the keyboard toolbar to start typing with your voice!

3. Translation Setup (Offline & Online)

  1. In LeanType, open Settings → Translation.
  2. Install the companion LeanType Translation Plugin (or configure Cloud/Self-Hosted AI for online builds).
  3. Download or import your required language translation models.
  4. Tap the Translate icon on the keyboard toolbar to translate selected text or your input field instantly.

4. Gesture Typing Setup

  1. In the standard and standardfull builds, open Settings → Gesture typing to download the gesture library automatically.
  2. In offline builds, download the library manually and load it via Settings → Gesture typing → Load gesture library.

5. Offline AI Setup (GGUF Models)

  1. Download a compatible GGUF model (such as Qwen2.5-0.5B-Instruct-Q4_K_M.gguf or Llama-3.2-1B-Instruct-Q4_K_M.gguf).
  2. In LeanType (offline build), navigate to Settings → Advanced → GGUF Model (.gguf) and select the file from your local storage.

🧩 Ecosystem & Plugins

Expand LeanType with official companion plugins:

Plugin Repository Description
🎙️ Voice Plugin LeanBitLab/Leantype-Voice-Plugin On-device Whisper speech-to-text engine
🌐 Translation Plugin LeanBitLab/LeanType-Translation-Plugin Dedicated on-device translation provider engine
✍️ Handwriting Plugin LeanBitLab/Leantype-Handwriting-Plugin ML Kit Digital Ink canvas recognition engine
🎨 Community Themes GitHub: leantype-theme Browse and share custom color themes

📱 More Android Projects by LeanBitLab

Discover our complete suite of privacy-first, open-source Android applications and utilities:
👉 Explore All LeanBitLab Android Projects

🤝 Community & Contributing

💖 Support the Project

Building and maintaining privacy-first, on-device AI and keyboard technologies requires continuous hardware testing, compute for model optimization, and development time.

If LeanType improves your daily typing workflow, please consider sponsoring our work!

Sponsor LeanBitLab on GitHub    Donate to LeanBitLab on Open Collective

📜 Credits & Acknowledgments

⚖️ License

LeanType is licensed under the GNU General Public License v3.0 (GPL-3.0).
See the LICENSE file for details.