QORM API reference
The canonical, machine-generated contract for QORM apps — extracted straight from the runtime source, so it never drifts from what the code actually does. This is the reference you (or your AI agent) code against; for tutorials and guides see the docs.
The declarative UI contract
- Node & widget props — the node schema, common style props, and every widget's specific props
- Widget catalog — every node
typethe renderer accepts, with aliases - Actions & state — every action step
typeand its fields - QScript language — the
.qsscripting language reference - Gestures — tap / long-press / swipe / drag, as widget props
- Animation — entrance effects and value-driven transitions
- Navigation — scenes, the navigate step, and page transitions
The runtime surface
- CLI: qorm — every command, flag, and exit code of the
qormbinary - HTTP & SSE — the endpoints
qorm runserves (browser, MCP, OTA) - Go package: qormext — the one public Go package, for app-owned native ops
- MCP tools — the tools an AI agent drives the live app with
- Capabilities — built-in hardware / OS ops and callbacks
Every page here except cli.md is regenerated from source byQORM_UPDATE_DOCS=1 go test ./...— do not hand-edit those.cli.mdis maintained by hand againstcmd/qorm/; update it when the CLI changes.