oclaw/desktop/README.md
oliver 420abac9f1 refactor: root-package imports (svc/runtime/interfaces) and fix PYTHONPATH
- Rename platform/ to svc/ to avoid shadowing stdlib platform.
- Replace from oclaw.* with from svc/runtime/interfaces; update -m CLI paths.
- tests/conftest: prepend repo root to sys.path (no parent-folder package name).
- CI: paths and offline_eval script under repo root.
- Ops scripts: PYTHONPATH must be repo root for python -m runtime.* (fixes gateway/WhatsApp sidecar startup).
- Fix default oclaw.json path in tabular/file attachment limits; stabilize attachment test config.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-13 14:51:17 +08:00

49 lines
1 KiB
Markdown

# Desktop Shell
Electron wrapper for existing `admin/chat` frontend with an embedded local backend process.
## Prerequisites
- Node.js 20+
- Python 3.10+ (available in `PATH` as `python`)
- Python deps installed in repo root:
```powershell
python -m pip install -r requirements.txt
```
## Development
From this `oclaw/desktop` directory:
```powershell
npm install
npm run dev
```
The app will:
1. Pick an available local port (default prefers `8787`).
2. Start backend using `python -m runtime.operations gateway start --host 127.0.0.1 --port <port>`.
3. Open `http://127.0.0.1:<port>/chat` in the desktop window.
Logs are written under:
- `%APPDATA%/oclaw/logs/backend.log` (Windows)
## Environment knobs
- `PYTHON_EXECUTABLE`: absolute path to python executable.
- `AIA_DESKTOP_BACKEND_PORT`: preferred backend port.
## Packaging (Windows)
```powershell
npm run pack:win
```
Output goes to `oclaw/desktop/dist/`, e.g.:
- `oclaw-setup-<version>.exe`
- `oclaw-setup-<version>.exe.blockmap`
- `win-unpacked/oclaw.exe`