Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 1.13 KB

README.md

File metadata and controls

45 lines (33 loc) · 1.13 KB

OpenGUI

OpenGUI is a desktop and web coding agent built on the first-party OpenGUI Host and Harness. The Host owns projects, model connections, Sessions, durable transcript history, and execution. The Harness exposes four workspace tools: read, write, edit, and shell.

Requirements

  • Node.js 22.19 or newer (release CI uses Node.js 24)
  • pnpm 11.18.0
  • An OpenAI-compatible model endpoint and API key

See docs/model-compatibility.md for the exact custom endpoint contract and docs/operations.md for security, backup, recovery, and troubleshooting guidance.

No external coding-agent CLI or SDK is required.

Development

pnpm install
pnpm run dev       # Electron
pnpm run dev:web   # browser

Verification

pnpm run check
pnpm run test
pnpm run slop-check
pnpm run build

Production

pnpm run start       # Electron
pnpm run start:web   # browser

See docs/architecture.md, docs/adr/0010-first-party-opengui-harness.md, and CONTRIBUTING.md.