Agent-ready guidance for building generative UI with OpenUI. This repository contains one skill that helps AI coding assistants build OpenUI apps, add generative UI to existing apps, and run them on OpenUI Gateway.
npx skills add thesysdev/skillsOnce installed, try prompts such as:
- "Build a generative UI agent that answers questions about our sales data."
- "Start a new OpenUI app with the shadcn design system."
- "Add generative UI to my assistant-ui chat."
- "Move my OpenAI Chat Completions backend to OpenUI Gateway."
- "Build a custom OpenUI component library for these domain objects."
- "Deploy this app and give me a preview URL."
| File | Covers |
|---|---|
SKILL.md |
What OpenUI is, which reference to read for each job, the rules every task follows, and the package map |
new-app.md |
Scaffolding with npx @openuidev/cli@latest create, the API key handoff, the default scaffold, customizing, and verifying |
existing-app.md |
Adding a component library, pointing the backend at Gateway, and rendering in assistant-ui, CopilotKit, or a custom chat |
gateway.md |
Gateway with Chat Completions: client setup, BYOK, the system prompt, conversation storage, tools, and security |
gateway-responses.md |
Apps that already use the Responses API: history models and hosted tools |
direct-provider.md |
Apps that call their own model provider directly: provider client, full prompt, app-owned storage |
autofix.md |
Correcting OpenUI Lang when inference stays with the user's provider |
component-library.md |
Defining and extending libraries, generating the spec, and keeping stored responses compatible |
agent-interface.md |
Agent Interface: stream adapters, storage, shell slots, and navigation |
artifacts.md |
Tool output as artifacts: renderers, parser inputs, and storage |
theming.md |
ThemeProvider, tokens, and light/dark/system mode |
reliability.md |
DevTools, Reliability Monitoring, and fixing generation errors |
deploy.md |
npx @openuidev/cli@latest deploy and its options |
openui-lang.md |
OpenUI Lang 1.0: syntax, state, queries, actions, errors, and validation |
examples.md |
Where the example catalog lives and how to use it |