README: rewrite for users — what it is, feature list, build-from-source (gateway/Android/desktop/pairing), contributing, Apache-2.0 license; add LICENSE file

2026-08-21 01:17:23 +02:00
1 parent 2f0cdbba17
commit d717c10256
@@ -0,0 +1,201 @@
 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/
   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
   1. Definitions.
      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.
      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.
      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.
      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.
      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.
      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.
      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).
      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.
      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."
      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.
   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.
   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.
   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:
      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and
      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and
      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and
      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.
      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.
   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.
   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.
   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.
   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.
   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.
   END OF TERMS AND CONDITIONS
   APPENDIX: How to apply the Apache License to your work.
      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.
   Copyright [yyyy] [name of copyright owner]
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
       http://www.apache.org/licenses/LICENSE-2.0
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
@@ -1,57 +1,138 @@
 # Iris × Hermes
-A **native Android + Desktop** experience for [hermes-agent](https://github.com/NousResearch/hermes-agent), connected through a **gateway platform plugin**.
+A chat app for [hermes-agent](https://github.com/NousResearch/hermes-agent): a **native Android app** and a **desktop app** (Linux, macOS, Windows) — both built from one shared Kotlin codebase (Compose Multiplatform).
-> ## ⚠️ HARD RULES
+Iris pairs with your running `hermes gateway` over a private WebSocket and gives you a Telegram-quality chat experience with your personal agent: streaming replies, visible reasoning, structured tool activity, channels, threads, media, search, and push notifications.
 > 1. **`hermes-agent/` is a read-only research reference. It is git-ignored and
 >    must NEVER be committed, pushed, or shipped.** We only *install* our plugin
 >    into a live hermes home (`~/.hermes/plugins/android`); we never modify hermes
 >    core.
 > 2. **ADB is installed and a device is connected** (`a5ca2a4b`, Xiaomi MIX 2S,
 >    Android 10 / API 29). Use it to install/launch/debug the app on-device.
-## Start here
+## Features
-📚 **The full implementation reference library is in [`docs/`](docs/README.md).**
+- **Native Hermes-Gateway integration** — your hermes → gateway → Iris app
-Read `docs/00-overview.md` first, then follow the numbered docs.
+- **Absolute Privacy!** — everything stays on your own infrastructure
 - **No file limit**
 - **No character limit**
 - **Full markdown support** — tables, checkmarks, bold, inline code, code blocks + syntax highlighting…
 - **HTML Artifact Preview** — agent-sent HTML/CSS/JS rendered in an in-app WebView
 - **All settings live in the app**, not in hermes `config.yml`! Change everything on the fly.
 - **Channels** — create channels to keep track of your reports, cronjobs, webhook calls
 - **Pin channels, rename them, change the color/icon**
 - **Customize how your chat should look like** — color? Check! Images? Check!
 - **Reasoning collapse/expandable** in the chat bubble
 - **Change the default behavior** of tool & reasoning verbosity
 - **Threads** — create your own, or let the AI create them with a title
 - **Search messages from everywhere**
-## Quickstart
+## How it works
-Full walkthrough: [`docs/setup.md`](docs/setup.md).
+```
 hermes-agent ──> hermes gateway ──(WebSocket :8790)──> Iris app (Android / Desktop)
 ```
-1. **Gateway:** install the plugin (`ln -s "$PWD/gateway-plugin" ~/.hermes/plugins/android`), run `hermes gateway setup` (generates the pairing token, prints the server URL), then `hermes gateway`.
+- `gateway-plugin/` is a hermes **platform plugin** (`android`). It runs inside the
-2. **App:** `cd app && ./gradlew :androidApp:installDebug` (Android; ADB device connected) or `./gradlew :desktopApp:run` (desktop).
+  `hermes gateway` process and opens a WebSocket server the apps connect to.
-3. **Pair:** on the app's Connect screen, enter the server URL (`ws://<gateway-ip>:8790/ws`) + pairing token, then **Test & Connect**.
+  Zero new Python dependencies, zero hermes-core changes.
-4. **Chat.**
+- `app/` is one Compose Multiplatform Gradle project: `:shared` (KMP, most of the
  code), `:androidApp` (native Kotlin + Jetpack Compose client), `:desktopApp`
  (the same app, tweaked for a big screen).
 - The app is a first-class hermes *messaging platform*, so everything the gateway
  already does just works: slash commands, cron delivery, `send_message` routing,
  coexistence with Telegram/Discord/etc.
 - Push notifications: FCM (primary) or ntfy (fallback).
-### Pairing notes
+## Build from source
- **Token location:** `~/.hermes/.env` on the gateway host (`ANDROID_TOKEN`), or the `hermes gateway setup` output (printed once, at generation).
+### Prerequisites
 - **Manual entry only:** the app has no QR scanner yet — the server prints a QR payload, but you type the URL + token.
 - **Default bind is `127.0.0.1`:** for a phone on the LAN, set `ANDROID_WS_HOST` to the gateway's LAN IP.
-## The three deliverables (this monorepo)
+| Where | You need |
 |---|---|
 | Gateway host | [hermes-agent](https://github.com/NousResearch/hermes-agent) with its venv (`uv sync`) |
 | Android build machine | JDK 17, Android SDK (`sdk.dir` in `app/local.properties` or `ANDROID_HOME`), ADB with a connected device |
 | Desktop build machine | JDK 17 only |
 No system Gradle needed — both apps use the project wrapper (`./gradlew`).
 ### 1. Gateway (on the gateway host)
 ```bash
 # hermes-agent is a separate project (not part of this repo)
 cd hermes-agent && uv sync
 # install the Iris plugin into the live hermes home
 mkdir -p ~/.hermes/plugins
 ln -s "$PWD/gateway-plugin" ~/.hermes/plugins/android
 hermes gateway status        # should list "android"
 hermes gateway setup         # generates ANDROID_TOKEN, prints the server URL
 hermes gateway               # run the gateway
 ```
 ### 2. Android app
 ```bash
 cd app
 ./gradlew :androidApp:installDebug    # build + install on the connected ADB device
 # or just build the APK:
 ./gradlew :androidApp:assembleDebug   # → app/androidApp/build/outputs/apk/debug/
 ```
 ### 3. Desktop app
 ```bash
 cd app
 ./gradlew :desktopApp:run             # dev run
 ./gradlew :desktopApp:jpackage        # native app-image (bundles the JRE)
 ```
 ### 4. Pair
 On the app's **Connect** screen:
 1. **Server URL** — `ws://<gateway-ip>:8790/ws` (printed by `hermes gateway setup`).
 2. **Pairing token** — from the setup output, or `ANDROID_TOKEN` in `~/.hermes/.env`
   on the gateway host.
 3. **Test & Connect.**
 Notes:
 - The app has **no QR scanner** — pairing is manual URL + token entry.
 - The default bind is `127.0.0.1` (desktop on the same machine only). For a phone
  on the LAN, set `ANDROID_WS_HOST` to the gateway's LAN IP.
 - Remote access: Tailscale/WireGuard, or a reverse proxy with CA-signed WSS
  (`ANDROID_WS_CERT` / `ANDROID_WS_KEY`).
 Full walkthrough, push setup (FCM/ntfy), and troubleshooting:
 [`docs/setup.md`](docs/setup.md).
 ## Contributing
 Contributions are welcome! Before you start:
 1. **Read the docs.** The full reference library is in [`docs/`](docs/README.md) —
   start with [`docs/00-overview.md`](docs/00-overview.md), then follow the
   numbered docs (architecture, wire protocol, plugin design, testing, …).
 2. **Know the layout.**
   | Path | What |
   |---|---|
-| `gateway-plugin/` | Python hermes **platform plugin** (`android`). Runs in the `hermes gateway` process; opens a WebSocket server the apps connect to. Zero new Python deps, zero hermes-core changes. |
+   | `gateway-plugin/` | Python hermes platform plugin (`android`); `protocol.py` is the frame source of truth |
-| `app/androidApp` | Native **Kotlin + Jetpack Compose** client. |
+   | `app/shared` | KMP module with most of the client code (shared by Android + Desktop) |
-| `app/desktopApp` | **Kotlin + Compose Multiplatform** client — the Android app, tweaked for a big screen (shares `app/shared`). |
+   | `app/androidApp` | Thin Android shell (package `dev.iris.app`) |
   | `app/desktopApp` | Thin desktop shell |
   | `docs/` | Numbered reference library |
-The Android and Desktop clients live in **one Compose Multiplatform Gradle
+3. **Run the tests.**
-project** (`app/`) with a shared KMP module (`app/shared`).
+   - Python (gateway plugin): `cd hermes-agent && scripts/run_tests.sh tests/gateway/test_android.py`
     (never bare `pytest` — hermes's runner sandboxes `HERMES_HOME`).
   - Kotlin: `cd app && ./gradlew :shared:testDebugUnitTest`
   - Live check (gateway must be running): `gateway-plugin/tests/ws_probe.py` and
     `gateway-plugin/tests/e2e.py` — see [`gateway-plugin/tests/README.md`](gateway-plugin/tests/README.md).
 4. **Keep the protocol in sync.** `gateway-plugin/protocol.py`,
   `app/shared/.../protocol/Protocol.kt`, and `docs/protocol/frames.schema.json`
   must always agree.
 5. **Pre-commit hooks** are configured (`.pre-commit-config.yaml`); run
   `pre-commit install` once after cloning.
-## Status
+Open an issue first for anything big, then send a pull request.
- **Phase:** M0–M6 complete; M7 (polish + E2E + docs) in progress.
+## License
 - **Milestones:** see [`docs/14-milestones.md`](docs/14-milestones.md).
 - **Locked decisions:** see [`docs/16-open-questions.md`](docs/16-open-questions.md).
-## Quick orientation
+Apache License 2.0 — see [LICENSE](LICENSE).
 - Architecture + rationale → [`docs/01-architecture.md`](docs/01-architecture.md)
 - Wire protocol → [`docs/04-wire-protocol.md`](docs/04-wire-protocol.md) (+ [`docs/protocol/frames.schema.json`](docs/protocol/frames.schema.json))
 - Gateway plugin design → [`docs/03-gateway-plugin.md`](docs/03-gateway-plugin.md)
 - hermes source cheat-sheet → [`docs/15-hermes-reference.md`](docs/15-hermes-reference.md)
 - Toolchain setup → [`docs/12-toolchain.md`](docs/12-toolchain.md)
 </file>