From d432738b1c6e5def4bd6818128f934f13422c7d7 Mon Sep 17 00:00:00 2001 From: yyovil Date: Fri, 12 Jun 2026 15:20:51 +0530 Subject: [PATCH] docs: document Electron app dev quick start (#196) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add an "Electron app (dev)" section: npm install + npm run dev under frontend/, with the explicit heads-up that the app does not start the daemon — it attaches over loopback to a daemon started via `ao start` (plus npm run dev:web for renderer-only work in a browser). Co-authored-by: Claude Fable 5 --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 6af7923f6..b8122082b 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,24 @@ go build -o /tmp/ao ./cmd/ao /tmp/ao session ls ``` +### Electron app (dev) + +The desktop supervisor lives under `frontend/` and is started separately: + +```bash +cd frontend +npm install +npm run dev # electron-forge start +``` + +Heads-up: `npm run dev` does **not** start the daemon for you. Start it first +(`ao start`, see above) — the renderer attaches to the running daemon over +loopback (`127.0.0.1:3001` by default, the `AO_PORT` from the table below). +Without a daemon the app opens but shows its daemon-not-ready state. + +For renderer-only UI work without the Electron shell, use +`npm run dev:web` (Vite in a regular browser). + ## CLI surface The CLI is intentionally thin: every product command resolves to a daemon HTTP