Files
openchamber-android-native/README.md
T
blumia 254d08b1bd feat: bootstrap OpenChamber native Android client
Add a Go client for OpenChamber built with Asuka's native widgets.

- internal/ocapi: health, password-to-device-token auth, session and
  message paging, prompt/interrupt/model/agent, permissions, SSE events,
  HTTP/SOCKS5 proxies and certificate pinning
- internal/storage: connection settings plus a device token in the
  platform keystore, with a per-install id for server-side dedupe
- internal/appui: connect, session list and chat screens with streaming
  Markdown, reasoning/tool folding, permission cards and session actions
- netcfg: native module that enables cleartext HTTP in release builds
- cmd/ocprobe: terminal probe for the API
- headless UI tests (uitest) and the research/plan document
2026-11-16 09:09:09 +08:00

73 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# OpenChamber Native
A lightweight OpenChamber client for phones, written in Go with
[Asuka](https://asuka.egoist.dev/)'s native widgets. Android first.
Status: M0–M3 done, M4 in progress — connect (password / passwordless, HTTP or
SOCKS5 proxy, self-signed certificates), live session list, chat with streaming
Markdown, permissions, archive/delete/rename, and a UI-independent API client.
## What is here
| Path | What |
| --- | --- |
| `internal/ocapi/` | OpenChamber HTTP client: auth (password → device token), sessions, messages, prompt/interrupt/model/agent, permissions, SSE events, HTTP/SOCKS5 proxy, certificate pinning |
| `internal/storage/` | Connection settings in `asuka/sdk/store`, device token in `asuka/sdk/secure` (Android Keystore), per-install id for device dedupe |
| `internal/appui/` | Screens: connect, sessions, chat (streaming Markdown, reasoning/tool folding, permissions) |
| `cmd/ocprobe/` | Terminal probe used to validate the API without a device |
| `PLAN.md` | Research, API contract, architecture, milestones, risks |
## Run
```bash
# terminal probe against a running server
go run ./cmd/ocprobe -url http://127.0.0.1:3000 health
go run ./cmd/ocprobe -url http://127.0.0.1:3000 -limit 5 sessions
go run ./cmd/ocprobe -url http://127.0.0.1:3000 -password secret sessions
go run ./cmd/ocprobe -url http://127.0.0.1:3000 -seconds 20 events
# the app on this computer (browser / GTK window)
asuka dev --platform web
asuka dev
# headless tests, including the UI
go test ./... -race
```
`asuka` must be installed from `main`; the v0.1.1 release does not build on
Linux:
```bash
go install github.com/egoist/asuka/cmd/asuka@main
```
## Android
The SDK lives at `~/SDK/AndroidSDK`, the JDKs at `~/SDK/jdk-21` (Gradle) and
`~/SDK/jdk-17` (the Android toolchain; registered in
`~/.gradle/gradle.properties` via `org.gradle.java.installations.paths`).
```bash
export ANDROID_HOME=$HOME/SDK/AndroidSDK
export JAVA_HOME=$HOME/SDK/jdk-21
export PATH=$ANDROID_HOME/platform-tools:$ANDROID_HOME/emulator:$JAVA_HOME/bin:$PATH
asuka dev --platform android --device emulator-5554 # hot reload
asuka dev --platform android --once --no-vet # build in, launch once
# release: a keystore is required
export ASUKA_KEYSTORE=$HOME/SDK/test-upload.jks ASUKA_KEY_ALIAS=upload
export ASUKA_KEYSTORE_PASSWORD=… ASUKA_KEY_PASSWORD=…
asuka build --platform android # dist/OpenChamber.aab
```
`netcfg/` is a native module whose only job is the Android manifest: it merges
`android:usesCleartextTraffic="true"` into **release** builds too, because
self-hosted OpenChamber servers are often plain HTTP on a LAN. Asuka enables it
for debug only. Delete the package (and its blank import in `main.go`) to
require HTTPS everywhere.
Proxies are entered as `http://host:port` or `socks5://host:port`
(no proxy authentication). Plain `http://` works in debug builds; the release
cleartext policy is decided in M5 (see `PLAN.md`).