OCTO Android Client provides a native, open-source enterprise instant messaging experience, integrating AI agents (Lobsters) for task execution. It targets users and developers seeking a self-hostable, human-centric workplace communication tool, offering a first-class mobile UX that mirrors its web counterpart.

How It Works

This native Kotlin/Java application communicates with octo-server via REST and WebSocket. It leverages AndroidX, Material 3 theming, and platform features like Foreground Services and Scoped Storage, avoiding webview wrappers for optimal mobile performance and integration. Its architecture mirrors octo-web's protocol and feature set, enabling consistent cross-client development.

Quick Start & Requirements

Download the latest APK from Releases for immediate use. For development builds, clone the repository, configure essential placeholders (Bundle ID, Firebase google-services.json, release keystore) as detailed in README-BUNDLE-ID.md, firebase-template.md, and keystore-template.md. Build using Gradle (./gradlew :app:assembleDebug) and install (./gradlew :app:installDebug). The app defaults to http://localhost:8080 for octo-server, configurable via app/src/main/res/values/config.xml. Android Studio (Giraffe+) is recommended.

Highlighted Details

• Pure native Android implementation (Kotlin/Java), eschewing webviews.
• Utilizes platform features: Foreground Service for push, Scoped Storage for attachments, Jetpack Compose/XML views.
• "Ships without secrets": Requires users to supply their own Firebase project, Bundle ID, and signing keystore.
• Protocol and feature parity with octo-web, including Lobster agent interactions.
• Proprietary elements are baked out via the octo-release pipeline before repository publication.

Maintenance & Community

The project adheres to standard contribution workflows outlined in CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md. It is maintained by OCTO Contributors under the Mininglamp-OSS umbrella. Specific community channels or roadmap details are not detailed in the provided README.

Licensing & Compatibility

Licensed under the Apache License 2.0, permitting broad use, modification, and distribution, including for commercial purposes and integration into closed-source applications.

Limitations & Caveats

Building a distributable APK requires significant pre-flight configuration, including replacing placeholder artifacts for Bundle ID, Firebase, and keystore. Users must also deploy and manage their own octo-server instance. The setup process is not a simple "install and run" for end-users without developer involvement.