OCTO — the open workplace built for humans × AI agents.
_{Let Lobsters (OpenClaw-powered digital doubles) do the thinking and doing. You focus on taste.}

🏠 OCTO Home · 🚀 Quickstart · 📦 Ecosystem · 🤝 Contributing

---

🌐 Read in: English · 简体中文

OCTO Android

Native Android client for the OCTO messaging platform — Kotlin / Java, talking to octo-server over REST + WebSocket.

octo-android is the official Android front-end for OCTO. It is a native Kotlin / Java app (not a webview wrapper) that talks to octo-server over REST + WebSocket, and drives the same Lobster-agent conversation surface as octo-web.

🌟 Why OCTO Android

• Native, not a webview. AndroidX-based, Material-themed, uses platform features (Foreground Service for message push, Scoped Storage for attachments, Jetpack Compose / XML views) rather than shipping a browser shell. First-class mobile UX for Lobster conversations.
• Ships without secrets. No google-services.json, no keystore, no Play Store listing bound to the upstream. You bring your own Firebase project, your own Bundle ID (com.example.octo placeholder → com.yourcompany.octo), your own keystore. All baked-out via the octo-release pipeline before this repo is published.
• Mirrors the web surface. Same REST + WebSocket protocol as octo-web, same i18n resource keys (English · 简体中文), same Lobster identity / streaming / typing indicators — so feature work can land on both clients without a protocol fork.

📥 Download

Download the latest APK from Releases, install it on your device, and enter your own octo-server address on the login screen.

No build required — just install and connect to your deployment.

🚀 Quickstart

⚠️ Mandatory pre-flight — this fork will not build a distributable APK until you swap three placeholder artefacts:

1. Bundle ID / applicationId — see README-BUNDLE-ID.md for the full rename checklist (com.example.octo → your reverse-DNS).
2. Firebase configuration — see firebase-template.md for how to obtain and drop in your own google-services.json.
3. Release keystore — see keystore-template.md for how to generate a signing keystore and wire it into Gradle.

Once those are done, a dev debug build is straightforward:

git clone https://github.com/Mininglamp-OSS/octo-android.git
cd octo-android

# Open in Android Studio (Giraffe+) and let it sync, or from CLI:
./gradlew :app:assembleDebug

# Install on a connected device:
./gradlew :app:installDebug

By default the app points at http://localhost:8080 for octo-server. Edit app/src/main/res/values/config.xml (or the flavor-specific equivalent) to aim at your own deployment.

📦 Modules / Architecture

Top-level layout (typical OCTO Android tree):

Runtime pillars:

1. Auth — token / refresh-token stored in EncryptedSharedPreferences.
2. Transport — OkHttp for REST + the WuKongIM Android SDK for the persistent WebSocket.
3. Persistence — Room database for message cache and offline drafts; Scoped-Storage-safe attachment handling.
4. Push — Firebase Cloud Messaging → foreground service → local notification channel.
5. UI — single-Activity + fragments (or Compose screens depending on flavour), Material 3 theming, RTL-safe layouts.

🔗 OCTO Ecosystem

graph TD
  subgraph Clients[Clients]
    Web[octo-web<br/>Web / PC]
    Android[octo-android<br/>Android]
    iOS[octo-ios<br/>iOS]
  end

  subgraph Core[Core Services]
    Server[octo-server<br/>Backend API]
    Matter[octo-matter<br/>Task / Todo]
    Summary[octo-smart-summary<br/>AI Summary]
    Admin[octo-admin<br/>Admin Console]
  end

  subgraph Shared[Shared Libraries & Integrations]
    Lib[octo-lib<br/>Core Go Library]
    Adapters[octo-adapters<br/>Third-party Adapters]
  end

  Web --> Server
  Android --> Server
  iOS --> Server
  Admin --> Server
  Server --> Matter
  Server --> Summary
  Server --> Adapters
  Server -.uses.-> Lib
  Matter -.uses.-> Lib
  Adapters -.uses.-> Lib

🧭 Philosophy

OCTO ships under three shared principles that apply to every repository in this matrix:

1. Local-first. Anything that can run on the user's own box — chats, embeddings, agents — should. Your data stays yours; cloud is a choice, not a requirement.
2. Humans judge, AI thinks and acts. Humans focus on taste (what matters, what's right, what to ship). Lobster agents — OpenClaw-powered digital doubles — carry the thinking and execution load.
3. Release-as-product. Every open-source cut is shipped as a self-contained product, not a code dump: one squash per release, Apache 2.0, no internal baggage, reproducible from this repo alone.

🤝 Contributing

We love pull requests! Before you open one, please read:

• CONTRIBUTING.md — workflow, branch model, commit style
• CODE_OF_CONDUCT.md — community expectations

For security issues please follow SECURITY.md instead of the public tracker.

📄 License

Apache License 2.0 — see LICENSE for the full text and NOTICE for third-party attributions.

🙏 Acknowledgments

octo-android owes its original scaffolding to:

• TangSengDaoDaoAndroid — our upstream, by the TangSengDaoDao team.
• WuKongIM — the real-time messaging core that octo-server drives behind this client.

See NOTICE for the full attribution list and third-party component licenses.

---

_{Made with 🐙 by OCTO Contributors · Mininglamp-OSS}