https://github.com/byte5ai/omadia-ui
https://github.com/byte5ai/omadia-ui
Last synced: 15 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/byte5ai/omadia-ui
- Owner: byte5ai
- Created: 2026-05-11T17:58:56.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-06-08T23:03:39.000Z (19 days ago)
- Last Synced: 2026-06-09T00:22:48.689Z (19 days ago)
- Size: 414 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# omadia-ui
### The canvas where your agents build the interface — live, deterministic, yours.
Omadia UI is the desktop surface for the [omadia](https://github.com/byte5ai/omadia)
agentic OS: agents synthesise real UI — tables, forms, charts, wizards, editor
regions — over a wire protocol, and the host renders it instantly in one
coherent material system. Persistent, multi-canvas, stateful. The interface is
no longer a chat log; it is a workspace the agent composes for the task at hand.
[](#license)
[](#status)
[](https://www.typescriptlang.org/)
[](app/)
[**Website**](https://omadia.ai) · [**Quickstart**](#-quickstart) · [**Concept**](CONCEPT.md) · [**Protocol**](docs/protocol/1.0.md) · [**Visual spec**](docs/visual-spec.md)
---
## Why a canvas instead of a chat?
Chat is the "DOS era" of LLM interaction: powerful but linear and text-only.
Omadia UI is the next layer — a desktop application where the agent
**materialises live UI** as it orchestrates a request across source systems
(Jira, ERP, HR, …):
- 🧱 **24 primitives, one protocol.** The wire format
(`omadia-canvas-protocol/1.0`) composes anything from a TUI-style list to a
Photoshop-class workspace — all rendered against a single validated,
CSP-safe whitelist.
- ⚡ **Deterministic where it matters.** Known flows get known UI: plugins
publish fixed canvas trees, navigation and refresh run LLM-free, and the
static app menu survives error states — the user is never stranded.
- 💡 **One material: Lume.** Light-as-material design system with hard rules
(surface-nesting ladder, chrome budget, three user-bindable palettes) —
enforced by the renderer for every tree, no per-plugin skinning.
- 🗂️ **A real workspace.** Multiple live canvases with their own server
sessions, tiling split panes, named desktops, a canvas library — all synced
through the omadia registry and restored on restart.
## ⚡ Quickstart
**Download:** grab the installer for your OS from the
[latest release](https://github.com/byte5ai/omadia-ui/releases) — macOS
(dmg, arm64/x64), Windows (NSIS) and Linux (AppImage) are built and attached
automatically for every release.
**Build from source:**
```sh
git clone https://github.com/byte5ai/omadia-ui.git
cd omadia-ui/app
npm ci
npm run dev # electron-vite dev against your omadia server
npm run dist # packaged installers into app/dist
```
On first start, point the app at your running
[omadia](https://github.com/byte5ai/omadia) server (WebSocket URL + login).
## How it works
Three tiers, split across client × server:
| Tier | Latency | What lives there |
|---|---|---|
| **1 — deterministic** | instant | This host app + `omadia-ui-channel`: rendering, validation, local operations, deterministic actions |
| **2 — small LLM** | sub-second | `omadia-ui-orchestrator`: composition, style inference, action routing |
| **3 — heavy LLM + tools** | seconds+ | omadia plugins: data, AI services, long-running operations |
See [`docs/architecture-3tier.svg`](docs/architecture-3tier.svg) and
[`CONCEPT.md`](CONCEPT.md) for the full architecture, security surface and
forward-compatibility constraints (shared canvases land in v2 without a wire
refactor).
## Documents
| File | Purpose |
|---|---|
| [`CONCEPT.md`](CONCEPT.md) | Architecture, primitives, protocol, security, identity, SDK extension plan |
| [`docs/visual-spec.md`](docs/visual-spec.md) | Lume material system — tokens, rules, composition idioms (v0.4) |
| [`docs/protocol/1.0.md`](docs/protocol/1.0.md) | Protocol specification + machine-validatable JSON Schemas |
| [`docs/walkthroughs.md`](docs/walkthroughs.md) | Use-case walkthroughs — multi-source comparison + editor micro-task |
| [`docs/tech-stack.md`](docs/tech-stack.md) | Tech-stack decision for the host app (Electron), with reasoning |
| [`app/`](app/) | The host application — Electron, strict TypeScript, vitest |
## Relationship to omadia core
Omadia UI rides on [`byte5ai/omadia`](https://github.com/byte5ai/omadia). The
protocol contract (`@omadia/canvas-core`: schemas + canonical fixtures) is
synced from the monorepo at build time — no vendored copy, no drift; a parity
test validates every canonical fixture against this renderer.
## Status
The host app is **implemented and in active development**: full 24-primitive
renderer, Lume v0.4 as renderer law, multi-canvas workspace (tiling, desktops,
library), deterministic refresh/actions/navigation, native login, streaming
plugin UI (X Studio as reference). Releases are cut automatically — every PR
merged to `main` produces a semantic version with generated notes and
installers for macOS, Windows and Linux.
macOS signing/notarization is intentionally deferred to the GA pipeline.
## License
MIT — Copyright © 2026 byte5 GmbH.
Maintained by [byte5 GmbH](https://byte5.de) under the GitHub organisation
[`byte5ai`](https://github.com/byte5ai).