The current beta path is a Kotlin/Jetpack Compose thin client that connects directly to an upstream Hermes gateway. Hermes remains authoritative for authentication, sessions, streaming, tools, and backend behavior.

Current Android Beta

Native Kotlin/Compose chat, session, settings, adaptive layout, and accessibility foundations.
Direct HTTPS gateway configuration with bearer/no-auth support and local-first routing.
Capability-gated session streaming and tool lifecycle output.
Semantic Android beta metadata at v0.1.0-beta.1.

Build and clean-install instructions are in Android Beta Build and Install. Device installation and the release criteria remain unverified until recorded on a real device or emulator.

Monorepo

apps/mobile       Vite React + Capacitor Android app
apps/companion    Fastify local companion server
packages/shared   Shared TypeScript API schemas/types
docs              Product, architecture, install, and API notes

Install Dependencies

This repo works with npm workspaces:

npm install

Companion Setup and Run

Generate/persist a local access key:

npm run companion:setup

The command prints:

Config path, normally ~/.config/hermes-mobile/companion.json
Safe workspace root
Access key such as hm_...

Start the companion server:

npm run companion:dev

The server listens on 0.0.0.0:8787 by default. Useful overrides:

PORT=8787 HOST=0.0.0.0 HERMES_MOBILE_WORKSPACE_ROOT=/path/to/workspace npm run companion:dev

All non-health endpoints require Authorization: Bearer <access-key>.

Mobile Development

Run the browser/PWA development shell:

npm run mobile:dev

Open Settings in the app and use:

Android emulator URL: http://10.0.2.2:8787
Physical device URL: http://<your-computer-lan-ip>:8787
Access key: value printed by npm run companion:setup

Tap Test connection to validate the server and key.

Android APK Build

Build the native direct-gateway client without Capacitor synchronization:

npm run android:build:debug

See Android Beta Build and Install for prerequisites, the versioned APK path, package checks, clean installation, direct-gateway setup, and known limitations.

Companion API

GET /api/health — no token required; returns service, Hermes CLI, workspace, and uptime.
GET /api/auth/validate — validates Authorization: Bearer <key>.
POST /api/chat — sends { "prompt": "..." } to local hermes CLI when available.
GET /api/files?path=. — lists workspace files/directories.
GET /api/files/read?path=README.md — reads UTF-8 file content.
POST /api/files/write — writes { "path": "notes.txt", "content": "..." }.
GET /api/files/metadata?path=README.md — returns download-style file metadata.
POST /api/terminal/run — runs { "command": "pwd && ls", "cwd": ".", "timeoutMs": 10000 } under the workspace root.

Docs

Languages

Kotlin 85.5%

TypeScript 11%

CSS 2.8%

JavaScript 0.5%

Shell 0.1%