No description
Find a file
Garfie Chiu 7652f669c4
Merge pull request #7 from garfiec/chore/package-rename
Rename package from com.librechat to com.garfiec.librechat
2026-04-03 16:20:55 -05:00
.claude/skills/sync-upstream chore: rename package com.librechat to com.garfiec.librechat 2026-04-03 16:12:37 -05:00
.github KMP iOS migration 2026-04-02 19:54:58 -05:00
app chore: rename package com.librechat to com.garfiec.librechat 2026-04-03 16:12:37 -05:00
build-logic KMP iOS migration 2026-04-02 19:54:58 -05:00
config/detekt Add linting and static code analysis 2026-03-28 12:49:37 -05:00
core chore: rename package com.librechat to com.garfiec.librechat 2026-04-03 16:12:37 -05:00
docs/screenshots Update README 2026-04-02 23:21:10 -05:00
feature chore: rename package com.librechat to com.garfiec.librechat 2026-04-03 16:12:37 -05:00
gradle Upgrade to Kotlin 2.3.20, CMP 1.11, AGP 9.1, Gradle 9.4 2026-04-02 19:54:58 -05:00
iosApp chore: rename package com.librechat to com.garfiec.librechat 2026-04-03 16:12:37 -05:00
shared chore: rename package com.librechat to com.garfiec.librechat 2026-04-03 16:12:37 -05:00
upstream@0736ff2668 Add sync-upstream skill and upstream submodule 2026-03-26 16:50:18 -05:00
.gitignore Initial release 2026-03-09 22:00:00 -05:00
.gitmodules Add sync-upstream skill and upstream submodule 2026-03-26 16:50:18 -05:00
build.gradle.kts KMP iOS migration 2026-04-02 19:54:58 -05:00
CLAUDE.md KMP iOS migration 2026-04-02 19:54:58 -05:00
compose-stability.conf chore: rename package com.librechat to com.garfiec.librechat 2026-04-03 16:12:37 -05:00
CONTRIBUTING.md KMP iOS migration 2026-04-02 19:54:58 -05:00
DISCOVERY.md KMP iOS migration 2026-04-02 19:54:58 -05:00
gradle.properties KMP iOS migration 2026-04-02 19:54:58 -05:00
gradlew KMP iOS migration 2026-04-02 19:54:58 -05:00
gradlew.bat KMP iOS migration 2026-04-02 19:54:58 -05:00
KNOWN_ISSUES.md Initial release 2026-03-09 22:00:00 -05:00
LICENSE Initial release 2026-03-09 22:00:00 -05:00
lint.xml Add linting and static code analysis 2026-03-28 12:49:37 -05:00
README.md Merge pull request #6 from garfiec/kmp_migration 2026-04-03 15:08:21 -05:00
settings.gradle.kts KMP iOS migration 2026-04-02 19:54:58 -05:00
UPSTREAM_VERSION Add sync-upstream skill and upstream submodule 2026-03-26 16:50:18 -05:00

LibreChat Android

LibreChat

A third-party native Android client for LibreChat. Not affiliated with the official LibreChat project — this is an independent app that connects to any self-hosted LibreChat server, no backend modifications required.

Features

  • Chat — Real-time streaming (SSE), message branching & sibling navigation, stop/regenerate/continue, markdown with syntax highlighting, LaTeX math rendering, code blocks with copy, image display, file attachments, tool call progress cards
  • Model Selection — Searchable bottom sheet grouped by endpoint, model comparison mode
  • Agents — Marketplace with search and categories, MCP server configuration
  • Conversations — Paginated list with date grouping, tags, search, rename, archive, delete, share, fork, duplicate, export/import
  • Presets & Prompts — Save/load chat presets, prompts library with @mention insertion
  • Authentication — Login, registration, forgot password, two-factor (TOTP + backup codes), OAuth (Google, GitHub, Discord, Facebook, Apple, OpenID)
  • Files — Upload, list, delete, inline image rendering with pinch-to-zoom
  • Voice — Speech-to-text input, text-to-speech playback (device and server engines)
  • Settings — Theme (system/light/dark), account management, data controls
  • Tablet — Adaptive dual-pane layout (600dp+) with persistent sidebar
  • Accessibility — Semantic headings, content descriptions, 48dp touch targets, live regions

Screenshots

Feature Phone Tablet / Foldable
Server Connect — Point the app at any self-hosted LibreChat server
Home Screen — Clean welcome screen with voice input and quick access
Conversations Sidebar — Swipe to open your chat history with search, tags, and date grouping
Predictive Back — Native Android back gesture with peek animation
Mermaid Diagrams — Interactive flowcharts and diagrams rendered in-chat
LaTeX Math — Beautifully typeset equations and formulas
Code Blocks — Syntax-highlighted code with language badge and copy button
Tables — Clean, scrollable data tables
Extended Thinking — See the model's reasoning process
Image Generation — AI-generated images via agents
Chat Options — Attach files, switch models, toggle tools, and tune parameters
Model Selection — Searchable bottom sheet with models grouped by provider
Model Parameters — Fine-tune temperature, top-p, tokens, and custom instructions
Photo Upload — Attach images from your gallery or camera
Settings — Theme, language, layout, and personalization options

Server Setup

The app works with any standard LibreChat server. During onboarding, you'll enter your server URL (e.g., https://chat.example.com or http://192.168.1.100:3080).

Required Configuration

Add the following to your LibreChat server's .env file:

# Safety net for native app clients.
# The app sends a browser User-Agent to pass the uaParser middleware,
# but if it ever fails to parse, this prevents ban point accumulation.
NON_BROWSER_VIOLATION_SCORE=0

Without this setting, the server's violation system may accumulate ban points against the Android client if the User-Agent check fails, eventually locking the account out.

Notes

  • Registration — The app respects your server's registration settings. If registration is disabled server-side, only the login form is shown.

Requirements

Tool Version
JDK 17+
Android Studio Latest stable
Xcode 15+ (iOS only)
Gradle 8.11.1 (via wrapper)
Kotlin 2.1.20

Building from Source

Android

./gradlew assembleDebug

The debug APK will be at app/build/outputs/apk/debug/app-debug.apk.

For a release build:

./gradlew assembleRelease

iOS

Build the shared KMP framework and open in Xcode:

./gradlew :shared:linkDebugFrameworkIosSimulatorArm64
open iosApp/iosApp.xcodeproj

Run on an iOS simulator from Xcode. The shared framework must be rebuilt whenever shared code changes.

Tech Stack

  • Kotlin Multiplatform (KMP) with shared business logic
  • Jetpack Compose (Android) + SwiftUI (iOS)
  • Koin (dependency injection)
  • Ktor Client with OkHttp engine
  • Kotlinx Serialization
  • Room (cache), DataStore (preferences), EncryptedSharedPreferences (tokens)
  • Kotlin 2.1.20, compileSdk 35, minSdk 26

Contributing

See CONTRIBUTING.md for development setup, code style, and PR guidelines.

License

This project is licensed under the MIT License.