Skip to content

The Open Standard for Generative UI

Suggested OpenUI Cloud Fixes & Refactor (#702)

ABcf788fece94f
diff --git a/docs/content/docs/agent/getting-started/quickstart.mdx b/docs/content/docs/agent/getting-started/quickstart.mdx
index f3ad719ac..601feb6eb 100644
--- a/docs/content/docs/agent/getting-started/quickstart.mdx
+++ b/docs/content/docs/agent/getting-started/quickstart.mdx
@@ -9,12 +9,21 @@ The CLI scaffolds a complete Next.js app: a streaming chat with a sidebar, threa
Run the create command and answer the prompts. One prompt asks **OpenUI Cloud or self-hosted?** Your choice decides which backend the scaffold wires up.
-<Tabs groupId="pkg" items={["npx", "pnpm", "yarn", "bun"]} persist>
- <Tab value="npx">```npx @openuidev/cli@latest create ```</Tab>
- <Tab value="pnpm">```pnpm dlx @openuidev/cli@latest create ```</Tab>
- <Tab value="yarn">```yarn dlx @openuidev/cli@latest create ```</Tab>
- <Tab value="bun">```bunx @openuidev/cli@latest create ```</Tab>
-</Tabs>
+```bash tab="pnpx" tab-group="pkg"
+pnpx @openuidev/cli@latest create
+```
+
+```bash tab="bun" tab-group="pkg"
+bunx @openuidev/cli@latest create
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dlx @openuidev/cli@latest create
+```
+
+```bash tab="npm" tab-group="pkg"
+npx @openuidev/cli@latest create
+```
When it finishes, move into the project:
@@ -53,12 +62,21 @@ The key stays on the server. The browser only ever talks to your route, never th
Start the dev server:
-<Tabs groupId="pkg" items={["npx", "pnpm", "yarn", "bun"]} persist>
- <Tab value="npx">```bash npm run dev ```</Tab>
- <Tab value="pnpm">```bash pnpm dev ```</Tab>
- <Tab value="yarn">```bash yarn dev ```</Tab>
- <Tab value="bun">```bash bun dev ```</Tab>
-</Tabs>
+```bash tab="pnpm" tab-group="pkg"
+pnpm dev
+```
+
+```bash tab="bun" tab-group="pkg"
+bun dev
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dev
+```
+
+```bash tab="npm" tab-group="pkg"
+npm run dev
+```
Open [http://localhost:3000](http://localhost:3000) and send a message. The response streams in token by token, and the assistant can render rich, interactive components inline.
diff --git a/docs/content/docs/api-reference/cli.mdx b/docs/content/docs/api-reference/cli.mdx
index 86a6c1c92..cd2f336bf 100644
--- a/docs/content/docs/api-reference/cli.mdx
+++ b/docs/content/docs/api-reference/cli.mdx
@@ -7,17 +7,42 @@ A command-line tool for scaffolding OpenUI chat apps and generating system promp
## Installation
-```bash
-# Run without installing
+Run without installing:
+
+```bash tab="pnpx" tab-group="pkg"
+pnpx @openuidev/cli@latest <command>
+```
+
+```bash tab="bun" tab-group="pkg"
+bunx @openuidev/cli@latest <command>
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dlx @openuidev/cli@latest <command>
+```
+
+```bash tab="npm" tab-group="pkg"
npx @openuidev/cli@latest <command>
+```
-# Or install globally
-npm install -g @openuidev/cli
+Or install globally:
+
+```bash tab="pnpm" tab-group="pkg"
pnpm add -g @openuidev/cli
-yarn global add @openuidev/cli
+```
+
+```bash tab="bun" tab-group="pkg"
bun add -g @openuidev/cli
```
+```bash tab="yarn" tab-group="pkg"
+yarn global add @openuidev/cli
+```
+
+```bash tab="npm" tab-group="pkg"
+npm install -g @openuidev/cli
+```
+
## `openui create`
Scaffolds a new Next.js app pre-configured with OpenUI Chat.
diff --git a/docs/content/docs/api-reference/react-email.mdx b/docs/content/docs/api-reference/react-email.mdx
index 858ae55b3..0463430ed 100644
--- a/docs/content/docs/api-reference/react-email.mdx
+++ b/docs/content/docs/api-reference/react-email.mdx
@@ -7,12 +7,20 @@ Use this package for LLM-driven email template generation with 44 email building
## Install
-```bash tab="npm"
-npm install @openuidev/react-email @openuidev/react-lang @react-email/render
+```bash tab="pnpm" tab-group="pkg"
+pnpm add @openuidev/react-email @openuidev/react-lang @react-email/render
```
-```bash tab="pnpm"
-pnpm add @openuidev/react-email @openuidev/react-lang @react-email/render
+```bash tab="bun" tab-group="pkg"
+bun add @openuidev/react-email @openuidev/react-lang @react-email/render
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn add @openuidev/react-email @openuidev/react-lang @react-email/render
+```
+
+```bash tab="npm" tab-group="pkg"
+npm install @openuidev/react-email @openuidev/react-lang @react-email/render
```
## `emailLibrary`
diff --git a/docs/content/docs/api-reference/react-ui.mdx b/docs/content/docs/api-reference/react-ui.mdx
index 3fcbdc5e3..e61e72e9d 100644
--- a/docs/content/docs/api-reference/react-ui.mdx
+++ b/docs/content/docs/api-reference/react-ui.mdx
@@ -113,7 +113,19 @@ import {
Generate the system prompt at build time with the CLI:
-```bash
+```bash tab="pnpx" tab-group="pkg"
+pnpx @openuidev/cli@latest generate ./src/library.ts --out src/generated/system-prompt.txt
+```
+
+```bash tab="bun" tab-group="pkg"
+bunx @openuidev/cli@latest generate ./src/library.ts --out src/generated/system-prompt.txt
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dlx @openuidev/cli@latest generate ./src/library.ts --out src/generated/system-prompt.txt
+```
+
+```bash tab="npm" tab-group="pkg"
npx @openuidev/cli@latest generate ./src/library.ts --out src/generated/system-prompt.txt
```
diff --git a/docs/content/docs/openui-lang/examples/dashboard.mdx b/docs/content/docs/openui-lang/examples/dashboard.mdx
index 375ca4336..65331a38c 100644
--- a/docs/content/docs/openui-lang/examples/dashboard.mdx
+++ b/docs/content/docs/openui-lang/examples/dashboard.mdx
@@ -82,7 +82,7 @@ await client.connect(new StreamableHTTPClientTransport(new URL("/api/mcp")));
## Try it
-```bash
+```bash tab="pnpm" tab-group="pkg"
git clone https://github.com/thesysdev/openui.git
cd openui/examples/openui-dashboard
pnpm install
@@ -90,4 +90,28 @@ echo "OPENAI_API_KEY=sk-your-key" > .env.local
pnpm dev
```
+```bash tab="bun" tab-group="pkg"
+git clone https://github.com/thesysdev/openui.git
+cd openui/examples/openui-dashboard
+bun install
+echo "OPENAI_API_KEY=sk-your-key" > .env.local
+bun dev
+```
+
+```bash tab="yarn" tab-group="pkg"
+git clone https://github.com/thesysdev/openui.git
+cd openui/examples/openui-dashboard
+yarn install
+echo "OPENAI_API_KEY=sk-your-key" > .env.local
+yarn dev
+```
+
+```bash tab="npm" tab-group="pkg"
+git clone https://github.com/thesysdev/openui.git
+cd openui/examples/openui-dashboard
+npm install
+echo "OPENAI_API_KEY=sk-your-key" > .env.local
+npm run dev
+```
+
Ask it to build a PostHog analytics dashboard, a ticket tracker, or a server monitoring view.
diff --git a/docs/content/docs/openui-lang/examples/harnesses/pi-agent-harness.mdx b/docs/content/docs/openui-lang/examples/harnesses/pi-agent-harness.mdx
index 171ae97cf..ae362d8ba 100644
--- a/docs/content/docs/openui-lang/examples/harnesses/pi-agent-harness.mdx
+++ b/docs/content/docs/openui-lang/examples/harnesses/pi-agent-harness.mdx
@@ -155,9 +155,23 @@ examples/harnesses/pi-agent-harness/
From the repo root, install workspace deps once, then run the example pointed at a project:
-```bash
+```bash tab="pnpm" tab-group="pkg"
pnpm install
+```
+```bash tab="bun" tab-group="pkg"
+bun install
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn install
+```
+
+```bash tab="npm" tab-group="pkg"
+npm install
+```
+
+```bash
cd examples/harnesses/pi-agent-harness
cp .env.example .env # set a provider API key (skip if you have a pi login)
pnpm dev -- /path/to/your/project
diff --git a/docs/content/docs/openui-lang/examples/harnesses/vercel-eve.mdx b/docs/content/docs/openui-lang/examples/harnesses/vercel-eve.mdx
index b5f9d28fc..3b56968b8 100644
--- a/docs/content/docs/openui-lang/examples/harnesses/vercel-eve.mdx
+++ b/docs/content/docs/openui-lang/examples/harnesses/vercel-eve.mdx
@@ -152,7 +152,7 @@ examples/harnesses/vercel-eve/
Eve 0.11 requires Node.js 24. From the repository root, follow these steps:
-```bash
+```bash tab="pnpm" tab-group="pkg"
# 1. Install workspace dependencies.
pnpm install
@@ -167,12 +167,72 @@ cp .env.example .env
pnpm dev
```
+```bash tab="bun" tab-group="pkg"
+# 1. Install workspace dependencies.
+bun install
+
+# 2. Enter the example.
+cd examples/harnesses/vercel-eve
+
+# 3. Configure an OpenAI-compatible model provider.
+cp .env.example .env
+# Edit .env and set LLM_API_KEY.
+
+# 4. Start Next.js and the embedded Eve development server.
+bun dev
+```
+
+```bash tab="yarn" tab-group="pkg"
+# 1. Install workspace dependencies.
+yarn install
+
+# 2. Enter the example.
+cd examples/harnesses/vercel-eve
+
+# 3. Configure an OpenAI-compatible model provider.
+cp .env.example .env
+# Edit .env and set LLM_API_KEY.
+
+# 4. Start Next.js and the embedded Eve development server.
+yarn dev
+```
+
+```bash tab="npm" tab-group="pkg"
+# 1. Install workspace dependencies.
+npm install
+
+# 2. Enter the example.
+cd examples/harnesses/vercel-eve
+
+# 3. Configure an OpenAI-compatible model provider.
+cp .env.example .env
+# Edit .env and set LLM_API_KEY.
+
+# 4. Start Next.js and the embedded Eve development server.
+npm run dev
+```
+
Open [http://localhost:3000](http://localhost:3000) and start a conversation. `OPENAI_API_KEY`,
`OPENAI_MODEL`, and `OPENAI_BASE_URL` are accepted as aliases for the `LLM_*` variables.
The repository scripts also expose Eve directly when you need to build or run the agent separately:
-```bash
+```bash tab="pnpm" tab-group="pkg"
pnpm eve:build
pnpm eve:start
```
+
+```bash tab="bun" tab-group="pkg"
+bun eve:build
+bun eve:start
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn eve:build
+yarn eve:start
+```
+
+```bash tab="npm" tab-group="pkg"
+npm run eve:build
+npm run eve:start
+```
diff --git a/docs/content/docs/openui-lang/examples/langgraph-chat.mdx b/docs/content/docs/openui-lang/examples/langgraph-chat.mdx
index 72df36075..9e820b27f 100644
--- a/docs/content/docs/openui-lang/examples/langgraph-chat.mdx
+++ b/docs/content/docs/openui-lang/examples/langgraph-chat.mdx
@@ -158,26 +158,68 @@ This example runs **two processes**, so use two terminals. Run these commands fr
1. Install dependencies and create a `.env` from the template:
-```bash
+```bash tab="pnpm" tab-group="pkg"
cd examples/langgraph-chat
pnpm install
cp .env.example .env
```
+```bash tab="bun" tab-group="pkg"
+cd examples/langgraph-chat
+bun install
+cp .env.example .env
+```
+
+```bash tab="yarn" tab-group="pkg"
+cd examples/langgraph-chat
+yarn install
+cp .env.example .env
+```
+
+```bash tab="npm" tab-group="pkg"
+cd examples/langgraph-chat
+npm install
+cp .env.example .env
+```
+
Add your `OPENAI_API_KEY` to `.env`. It is read by the **LangGraph server** (which runs the LLM), so it belongs next to `langgraph.json`. The Next.js app only needs the `LANGGRAPH_*` variables, which already default to the local server.
2. **Terminal 1: LangGraph server** (generates the OpenUI prompt, then hot-reloads the graph on `:2024`):
-```bash
+```bash tab="pnpm" tab-group="pkg"
pnpm langgraph:dev
```
+```bash tab="yarn" tab-group="pkg"
+yarn langgraph:dev
+```
+
+```bash tab="bun" tab-group="pkg"
+bun langgraph:dev
+```
+
+```bash tab="npm" tab-group="pkg"
+npm langgraph:dev
+```
+
3. **Terminal 2: Next.js app**:
-```bash
+```bash tab="pnpm" tab-group="pkg"
pnpm dev
```
+```bash tab="bun" tab-group="pkg"
+bun dev
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dev
+```
+
+```bash tab="npm" tab-group="pkg"
+npm run dev
+```
+
Open [http://localhost:3000](http://localhost:3000) and try a starter such as "Weather in Tokyo" or "AAPL stock price".
## Deploy to LangGraph Platform
diff --git a/docs/content/docs/openui-lang/examples/react-email.mdx b/docs/content/docs/openui-lang/examples/react-email.mdx
index 5b8307c47..3399742ca 100644
--- a/docs/content/docs/openui-lang/examples/react-email.mdx
+++ b/docs/content/docs/openui-lang/examples/react-email.mdx
@@ -101,11 +101,26 @@ Run these commands from `examples/react-email`.
1. Install dependencies:
-```bash
+```bash tab="pnpm" tab-group="pkg"
cd examples/react-email
pnpm install
```
+```bash tab="bun" tab-group="pkg"
+cd examples/react-email
+bun install
+```
+
+```bash tab="yarn" tab-group="pkg"
+cd examples/react-email
+yarn install
+```
+
+```bash tab="npm" tab-group="pkg"
+cd examples/react-email
+npm install
+```
+
2. Create a `.env.local` file with your API key:
```bash
@@ -114,8 +129,20 @@ OPENAI_API_KEY=sk-...
3. Start the dev server:
-```bash
+```bash tab="pnpm" tab-group="pkg"
pnpm dev
```
+```bash tab="bun" tab-group="pkg"
+bun dev
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dev
+```
+
+```bash tab="npm" tab-group="pkg"
+npm run dev
+```
+
This auto-generates the system prompt from the email component library and starts the Next.js dev server.
diff --git a/docs/content/docs/openui-lang/examples/react-native.mdx b/docs/content/docs/openui-lang/examples/react-native.mdx
index 8daf08453..ba5d70c3b 100644
--- a/docs/content/docs/openui-lang/examples/react-native.mdx
+++ b/docs/content/docs/openui-lang/examples/react-native.mdx
@@ -66,11 +66,26 @@ Run these commands from `examples/openui-react-native`.
1. Install dependencies:
-```bash
+```bash tab="pnpm" tab-group="pkg"
cd examples/openui-react-native
pnpm install
```
+```bash tab="bun" tab-group="pkg"
+cd examples/openui-react-native
+bun install
+```
+
+```bash tab="yarn" tab-group="pkg"
+cd examples/openui-react-native
+yarn install
+```
+
+```bash tab="npm" tab-group="pkg"
+cd examples/openui-react-native
+npm install
+```
+
2. Configure the backend:
```bash
@@ -85,24 +100,60 @@ OPENAI_API_KEY=sk-...
3. Generate the prompt file used by the backend:
-```bash
+```bash tab="pnpm" tab-group="pkg"
pnpm generate:prompt
```
+```bash tab="bun" tab-group="pkg"
+bun generate:prompt
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn generate:prompt
+```
+
+```bash tab="npm" tab-group="pkg"
+npm generate:prompt
+```
+
This generates `backend/src/system-prompt.txt` from `backend/src/library.ts`. Re-run it any time you change component names, schemas, descriptions, or prompt rules.
4. Start the Next.js backend:
-```bash
+```bash tab="pnpm" tab-group="pkg"
pnpm dev:backend
```
+```bash tab="bun" tab-group="pkg"
+bun dev:backend
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dev:backend
+```
+
+```bash tab="npm" tab-group="pkg"
+npm dev:backend
+```
+
5. Start the Expo app in a second terminal:
-```bash
+```bash tab="pnpm" tab-group="pkg"
pnpm dev:mobile
```
+```bash tab="bun" tab-group="pkg"
+bun dev:mobile
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dev:mobile
+```
+
+```bash tab="npm" tab-group="pkg"
+npm dev:mobile
+```
+
By default, `chat-app/metro.config.js` auto-detects your local IP address and sets `EXPO_PUBLIC_BACKEND_URL` to `http://<your-ip>:3000/api/chat`. If you need to point the app somewhere else, set `EXPO_PUBLIC_BACKEND_URL` yourself before starting Expo.
If you are testing on a physical device, make sure the phone and your development machine are on the same network.
diff --git a/docs/content/docs/openui-lang/examples/shadcn-chat.mdx b/docs/content/docs/openui-lang/examples/shadcn-chat.mdx
index de299ec9c..d21c1c50d 100644
--- a/docs/content/docs/openui-lang/examples/shadcn-chat.mdx
+++ b/docs/content/docs/openui-lang/examples/shadcn-chat.mdx
@@ -91,11 +91,26 @@ Run these commands from `examples/shadcn-chat`.
1. Install dependencies:
-```bash
+```bash tab="pnpm" tab-group="pkg"
cd examples/shadcn-chat
pnpm install
```
+```bash tab="bun" tab-group="pkg"
+cd examples/shadcn-chat
+bun install
+```
+
+```bash tab="yarn" tab-group="pkg"
+cd examples/shadcn-chat
+yarn install
+```
+
+```bash tab="npm" tab-group="pkg"
+cd examples/shadcn-chat
+npm install
+```
+
2. Create a `.env.local` file with your API key:
```bash
@@ -104,6 +119,18 @@ OPENAI_API_KEY=sk-...
3. Start the dev server:
-```bash
+```bash tab="pnpm" tab-group="pkg"
pnpm dev
```
+
+```bash tab="bun" tab-group="pkg"
+bun dev
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dev
+```
+
+```bash tab="npm" tab-group="pkg"
+npm run dev
+```
diff --git a/docs/content/docs/openui-lang/examples/vercel-ai-chat.mdx b/docs/content/docs/openui-lang/examples/vercel-ai-chat.mdx
index 69b74c921..8f9b8ac35 100644
--- a/docs/content/docs/openui-lang/examples/vercel-ai-chat.mdx
+++ b/docs/content/docs/openui-lang/examples/vercel-ai-chat.mdx
@@ -101,11 +101,26 @@ Run these commands from `examples/vercel-ai-chat`.
1. Install dependencies:
-```bash
+```bash tab="pnpm" tab-group="pkg"
cd examples/vercel-ai-chat
pnpm install
```
+```bash tab="bun" tab-group="pkg"
+cd examples/vercel-ai-chat
+bun install
+```
+
+```bash tab="yarn" tab-group="pkg"
+cd examples/vercel-ai-chat
+yarn install
+```
+
+```bash tab="npm" tab-group="pkg"
+cd examples/vercel-ai-chat
+npm install
+```
+
2. Create a `.env.local` file with your API key:
```bash
@@ -114,8 +129,20 @@ OPENAI_API_KEY=sk-...
3. Start the dev server:
-```bash
+```bash tab="pnpm" tab-group="pkg"
pnpm dev
```
+```bash tab="bun" tab-group="pkg"
+bun dev
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dev
+```
+
+```bash tab="npm" tab-group="pkg"
+npm run dev
+```
+
This generates the system prompt from the OpenUI component library and starts the Next.js dev server.
diff --git a/docs/content/docs/openui-lang/quickstart.mdx b/docs/content/docs/openui-lang/quickstart.mdx
index 4224909f9..6aa877eb7 100644
--- a/docs/content/docs/openui-lang/quickstart.mdx
+++ b/docs/content/docs/openui-lang/quickstart.mdx
@@ -14,8 +14,25 @@ description: Bootstrap a GenUI chat app in under a minute.
## Create the app
-```bash
+```bash tab="pnpx" tab-group="pkg"
+pnpx @openuidev/cli@latest create --name genui-chat-app
+```
+
+```bash tab="bun" tab-group="pkg"
+bunx @openuidev/cli@latest create --name genui-chat-app
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dlx @openuidev/cli@latest create --name genui-chat-app
+```
+
+```bash tab="npm" tab-group="pkg"
npx @openuidev/cli@latest create --name genui-chat-app
+```
+
+Then move into the project:
+
+```bash
cd genui-chat-app
```
@@ -29,7 +46,19 @@ echo "OPENAI_API_KEY=sk-your-key-here" > .env
## Start the dev server
-```bash
+```bash tab="pnpm" tab-group="pkg"
+pnpm dev
+```
+
+```bash tab="bun" tab-group="pkg"
+bun dev
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dev
+```
+
+```bash tab="npm" tab-group="pkg"
npm run dev
```
diff --git a/docs/content/docs/openui-lang/standard-library.mdx b/docs/content/docs/openui-lang/standard-library.mdx
index f8eeeaeef..f02a38ec1 100644
--- a/docs/content/docs/openui-lang/standard-library.mdx
+++ b/docs/content/docs/openui-lang/standard-library.mdx
@@ -7,7 +7,19 @@ OpenUI ships with a prebuilt `openuiLibrary` for common layouts, forms, content,
## Install
-```bash
+```bash tab="pnpm" tab-group="pkg"
+pnpm add @openuidev/react-lang @openuidev/react-ui
+```
+
+```bash tab="bun" tab-group="pkg"
+bun add @openuidev/react-lang @openuidev/react-ui
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn add @openuidev/react-lang @openuidev/react-ui
+```
+
+```bash tab="npm" tab-group="pkg"
npm install @openuidev/react-lang @openuidev/react-ui
```
@@ -25,7 +37,19 @@ import { openuiLibrary } from "@openuidev/react-ui";
Use the CLI to generate the system prompt at build time:
-```bash
+```bash tab="pnpx" tab-group="pkg"
+pnpx @openuidev/cli@latest generate ./src/library.ts --out src/generated/system-prompt.txt
+```
+
+```bash tab="bun" tab-group="pkg"
+bunx @openuidev/cli@latest generate ./src/library.ts --out src/generated/system-prompt.txt
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dlx @openuidev/cli@latest generate ./src/library.ts --out src/generated/system-prompt.txt
+```
+
+```bash tab="npm" tab-group="pkg"
npx @openuidev/cli@latest generate ./src/library.ts --out src/generated/system-prompt.txt
```
diff --git a/docs/content/docs/openui-lang/system-prompts.mdx b/docs/content/docs/openui-lang/system-prompts.mdx
index e2253eb3b..2230acfce 100644
--- a/docs/content/docs/openui-lang/system-prompts.mdx
+++ b/docs/content/docs/openui-lang/system-prompts.mdx
@@ -9,19 +9,55 @@ The system prompt tells the LLM how to output valid OpenUI Lang. There are two w
The fastest way to generate a system prompt — works with any backend language:
-```bash
+```bash tab="pnpx" tab-group="pkg"
+pnpx @openuidev/cli@latest generate ./src/library.ts
+```
+
+```bash tab="bun" tab-group="pkg"
+bunx @openuidev/cli@latest generate ./src/library.ts
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dlx @openuidev/cli@latest generate ./src/library.ts
+```
+
+```bash tab="npm" tab-group="pkg"
npx @openuidev/cli@latest generate ./src/library.ts
```
Write to a file:
-```bash
+```bash tab="pnpx" tab-group="pkg"
+pnpx @openuidev/cli@latest generate ./src/library.ts --out system-prompt.txt
+```
+
+```bash tab="bun" tab-group="pkg"
+bunx @openuidev/cli@latest generate ./src/library.ts --out system-prompt.txt
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dlx @openuidev/cli@latest generate ./src/library.ts --out system-prompt.txt
+```
+
+```bash tab="npm" tab-group="pkg"
npx @openuidev/cli@latest generate ./src/library.ts --out system-prompt.txt
```
Generate the component spec as JSON (for use with `generatePrompt`):
-```bash
+```bash tab="pnpx" tab-group="pkg"
+pnpx @openuidev/cli@latest generate ./src/library.ts --json-schema
+```
+
+```bash tab="bun" tab-group="pkg"
+bunx @openuidev/cli@latest generate ./src/library.ts --json-schema
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dlx @openuidev/cli@latest generate ./src/library.ts --json-schema
+```
+
+```bash tab="npm" tab-group="pkg"
npx @openuidev/cli@latest generate ./src/library.ts --json-schema
```
@@ -33,7 +69,19 @@ For backends that need dynamic prompts - different tools, preambles, or feature
First, generate the component spec JSON via the CLI:
-```bash
+```bash tab="pnpx" tab-group="pkg"
+pnpx @openuidev/cli generate ./src/library.ts --json-schema --out generated/component-spec.json
+```
+
+```bash tab="bun" tab-group="pkg"
+bunx @openuidev/cli generate ./src/library.ts --json-schema --out generated/component-spec.json
+```
+
+```bash tab="yarn" tab-group="pkg"
+yarn dlx @openuidev/cli generate ./src/library.ts --json-schema --out generated/component-spec.json
+```
+
+```bash tab="npm" tab-group="pkg"
npx @openuidev/cli generate ./src/library.ts --json-schema --out generated/component-spec.json
```
diff --git a/package.json b/package.json
index f9231c4ca..2da5c4fdd 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "OpenUI",
- "version": "1.0.0",
+ "version": "1.0.1",
"description": "The open standard for generative UI — a streaming-first language, React runtime, and component libraries for building AI-powered chat and copilot interfaces",
"main": "index.js",
"scripts": {
diff --git a/packages/openui-cli/README.md b/packages/openui-cli/README.md
index 216a15f25..72ce361c8 100644
--- a/packages/openui-cli/README.md
+++ b/packages/openui-cli/README.md
@@ -35,7 +35,7 @@ npx @openuidev/cli@latest create
Skip the prompt and pick a template directly:
```bash
-npx @openuidev/cli@latest create --template openui-chat
+npx @openuidev/cli@latest create --template openui-self-hosted
npx @openuidev/cli@latest create --template openui-cloud
```
@@ -64,7 +64,7 @@ openui create [options]
Options:
- `-n, --name <string>`: Project name
-- `-t, --template <template>`: Template to scaffold — `openui-chat` or `openui-cloud`
+- `-t, --template <template>`: Template to scaffold — `openui-self-hosted` or `openui-cloud`
- `--skill`: Install the OpenUI agent skill for AI coding assistants
- `--no-skill`: Skip installing the OpenUI agent skill
- `--no-install`: Scaffold without running the package install
@@ -97,7 +97,7 @@ Examples:
```bash
openui create
-openui create --name my-app --template openui-chat
+openui create --name my-app --template openui-self-hosted
openui create --name my-app --template openui-cloud --auth oauth
openui create --name my-app --template openui-cloud --api-key tk_your_key
openui create --name my-app --no-skill --no-install
diff --git a/packages/openui-cli/scripts/build-templates.js b/packages/openui-cli/scripts/build-templates.js
index 03f5b7126..1978d3c7c 100644
--- a/packages/openui-cli/scripts/build-templates.js
+++ b/packages/openui-cli/scripts/build-templates.js
@@ -2,7 +2,7 @@ const fs = require("node:fs");
const path = require("node:path");
const { rimrafSync } = require("rimraf");
-const TEMPLATES = ["openui-chat", "openui-cloud"];
+const TEMPLATES = ["openui-self-hosted", "openui-cloud"];
for (const template of TEMPLATES) {
const srcDir = path.resolve(__dirname, "../src/templates", template);
diff --git a/packages/openui-cli/src/commands/create-app.ts b/packages/openui-cli/src/commands/create-app.ts
index 86726677a..bc9e1bc13 100644
--- a/packages/openui-cli/src/commands/create-app.ts
+++ b/packages/openui-cli/src/commands/create-app.ts
@@ -4,12 +4,12 @@ import * as os from "node:os";
import * as path from "node:path";
import { resolveCloudApiKey, THESYS_KEYS_URL, type CloudAuthMethod } from "../auth/mint";
-import { detectPackageManager } from "../lib/detect-package-manager";
+import { resolveInstallPackageManager } from "../lib/detect-package-manager";
import { runSkillInstall, shouldInstallSkill } from "../lib/install-skill";
import { resolveArgs } from "../lib/resolve-args";
import { CreateError, telemetry } from "../lib/telemetry";
-export type TemplateName = "openui-chat" | "openui-cloud";
+export type TemplateName = "openui-self-hosted" | "openui-cloud";
export interface CreateAppOptions {
name?: string;
@@ -47,11 +47,14 @@ export async function runCreateApp(options: CreateAppOptions): Promise<void> {
type: "select",
message: "Which template?",
choices: [
- { value: "openui-chat", name: "OpenUI Chat — bring your own model key (OpenAI)" },
{
value: "openui-cloud",
name: "OpenUI Cloud — managed conversations, artifacts & streaming",
},
+ {
+ value: "openui-self-hosted",
+ name: "OpenUI Self Hosted — starter setup with OpenAI SDK",
+ },
],
},
required: true,
@@ -70,8 +73,8 @@ export async function runCreateApp(options: CreateAppOptions): Promise<void> {
throw new CreateError("dir_exists", `Directory "${name}" already exists.`);
}
- const runner = detectPackageManager();
- telemetry.register({ package_manager: runner });
+ const packageManager = resolveInstallPackageManager();
+ telemetry.register({ package_manager: packageManager.name });
const templateDir = path.join(__dirname, "..", "templates", template);
if (!fs.existsSync(templateDir)) {
throw new CreateError(
@@ -120,14 +123,7 @@ export async function runCreateApp(options: CreateAppOptions): Promise<void> {
}
fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
- const installCmd =
- runner === "pnpm dlx"
- ? "pnpm install"
- : runner === "yarn dlx"
- ? "yarn"
- : runner === "bunx"
- ? "bun install"
- : "npm install";
+ const installCmd = packageManager.installCmd;
if (options.noInstall) {
console.info(`Skipping dependency install (--no-install). Run \`${installCmd}\` later.\n`);
@@ -145,18 +141,11 @@ export async function runCreateApp(options: CreateAppOptions): Promise<void> {
if (installSkill) runSkillInstall(targetDir);
const envWritten =
- template === "openui-cloud"
- ? await writeCloudEnv(targetDir, name, options, interactive)
- : await writeChatEnv(targetDir, interactive);
-
- const devCmd =
- runner === "pnpm dlx"
- ? "pnpm"
- : runner === "yarn dlx"
- ? "yarn"
- : runner === "bunx"
- ? "bun"
- : "npm";
+ template === "openui-self-hosted"
+ ? await writeChatEnv(targetDir, interactive)
+ : await writeCloudEnv(targetDir, name, options, interactive);
+
+ const devCmd = packageManager.runCmd;
telemetry.capture("cli_create_succeeded", {
template,
diff --git a/packages/openui-cli/src/index.ts b/packages/openui-cli/src/index.ts
index 68486d165..3835c24dd 100644
--- a/packages/openui-cli/src/index.ts
+++ b/packages/openui-cli/src/index.ts
@@ -30,9 +30,9 @@ program.hook("preAction", (_thisCommand, actionCommand) => {
program
.command("create")
- .description("Scaffold a new Next.js app (OpenUI Chat or OpenUI Cloud)")
+ .description("Scaffold a new Next.js app (OpenUI Self Hosted or OpenUI Cloud)")
.option("-n, --name <string>", "Project name")
- .option("-t, --template <template>", "Template: openui-chat | openui-cloud")
+ .option("-t, --template <template>", "Template: openui-self-hosted | openui-cloud")
.option("--api-key <key>", "OpenUI Cloud API key (cloud template; skips sign-in)")
.option("--auth <method>", "Cloud auth method: oauth | manual | skip")
.option("--skill", "Install the OpenUI agent skill for AI coding assistants")
diff --git a/packages/openui-cli/src/lib/detect-package-manager.ts b/packages/openui-cli/src/lib/detect-package-manager.ts
index dad275b7e..c980bc02c 100644
--- a/packages/openui-cli/src/lib/detect-package-manager.ts
+++ b/packages/openui-cli/src/lib/detect-package-manager.ts
@@ -1,10 +1,42 @@
-type PackageManagerRunner = "npx" | "pnpm dlx" | "yarn dlx" | "bunx";
+import { execSync } from "node:child_process";
-export function detectPackageManager(): PackageManagerRunner {
+export type PackageManagerName = "pnpm" | "yarn" | "bun" | "npm";
+
+export interface PackageManager {
+ name: PackageManagerName;
+ installCmd: string;
+ runCmd: string;
+}
+
+const PACKAGE_MANAGERS: Record<PackageManagerName, PackageManager> = {
+ pnpm: { name: "pnpm", installCmd: "pnpm install", runCmd: "pnpm" },
+ yarn: { name: "yarn", installCmd: "yarn", runCmd: "yarn" },
+ bun: { name: "bun", installCmd: "bun install", runCmd: "bun" },
+ npm: { name: "npm", installCmd: "npm install", runCmd: "npm" },
+};
+
+function detectInvokingPackageManager(): PackageManagerName | null {
const userAgent = process.env["npm_config_user_agent"] ?? "";
+ if (userAgent.startsWith("pnpm/")) return "pnpm";
+ if (userAgent.startsWith("yarn/")) return "yarn";
+ if (userAgent.startsWith("bun/")) return "bun";
+ if (userAgent.startsWith("npm/")) return "npm";
+ return null;
+}
+
+function isPnpmAvailable(): boolean {
+ try {
+ execSync("pnpm --version", { stdio: "ignore" });
+ return true;
+ } catch {
+ return false;
+ }
+}
- if (userAgent.startsWith("pnpm/")) return "pnpm dlx";
- if (userAgent.startsWith("yarn/")) return "yarn dlx";
- if (userAgent.startsWith("bun/")) return "bunx";
- return "npx";
+export function resolveInstallPackageManager(): PackageManager {
+ const invoking = detectInvokingPackageManager();
+ if (invoking === "pnpm" || invoking === "yarn" || invoking === "bun") {
+ return PACKAGE_MANAGERS[invoking];
+ }
+ return isPnpmAvailable() ? PACKAGE_MANAGERS.pnpm : PACKAGE_MANAGERS.npm;
}
diff --git a/packages/openui-cli/src/lib/utils.ts b/packages/openui-cli/src/lib/utils.ts
index c59467c76..17b4a2528 100644
--- a/packages/openui-cli/src/lib/utils.ts
+++ b/packages/openui-cli/src/lib/utils.ts
@@ -17,9 +17,12 @@ export function handleCliError(e: unknown, event: string, telemetry?: Telemetry)
export function normalizeTemplate(t?: string): TemplateName | undefined {
if (!t) return undefined;
const v = t.toLowerCase();
- if (v === "chat" || v === "openui-chat") return "openui-chat";
+ if (v === "self-hosted" || v === "openui-self-hosted") return "openui-self-hosted";
if (v === "cloud" || v === "openui-cloud") return "openui-cloud";
- throw new CreateError("bad_args", `unknown template "${t}". Use: openui-chat | openui-cloud.`);
+ throw new CreateError(
+ "bad_args",
+ `unknown template "${t}". Use: openui-self-hosted | openui-cloud.`,
+ );
}
export function normalizeAuth(a?: string): CloudAuthMethod | undefined {
diff --git a/packages/openui-cli/src/templates/openui-cloud/package.json b/packages/openui-cli/src/templates/openui-cloud/package.json
index 4954c6372..294d28682 100644
--- a/packages/openui-cli/src/templates/openui-cloud/package.json
+++ b/packages/openui-cli/src/templates/openui-cloud/package.json
@@ -28,7 +28,6 @@
"katex": "0.16.44",
"lodash": "4.17.21",
"lucide-react": "^0.575.0",
- "mdast-util-find-and-replace": "3.0.2",
"mermaid": "11.15.0",
"next": "16.1.6",
"react": "19.2.3",
diff --git a/packages/openui-cli/src/templates/openui-cloud/src/app/api/chat/route.ts b/packages/openui-cli/src/templates/openui-cloud/src/app/api/chat/route.ts
index 029d59aa8..26b5de895 100644
--- a/packages/openui-cli/src/templates/openui-cloud/src/app/api/chat/route.ts
+++ b/packages/openui-cli/src/templates/openui-cloud/src/app/api/chat/route.ts
@@ -43,7 +43,7 @@ export async function POST(req: Request) {
try {
stream = (await client.responses.create(
{
- model: envOr("OPENUI_MODEL", "anthropic/claude-sonnet-4.6"),
+ model: envOr("OPENUI_MODEL", "google/gemini-3.1-pro"),
conversation: threadId, // store:true persists to the conversation
input,
stream: true,
diff --git a/packages/openui-cli/src/templates/openui-cloud/src/app/page.tsx b/packages/openui-cli/src/templates/openui-cloud/src/app/page.tsx
index 9c0006c4a..2892fca23 100644
--- a/packages/openui-cli/src/templates/openui-cloud/src/app/page.tsx
+++ b/packages/openui-cli/src/templates/openui-cloud/src/app/page.tsx
@@ -56,6 +56,14 @@ export default function Page() {
scrollOnLoad={false}
theme={{ mode }}
starters={[
+ {
+ displayText: "Summarize EV trends",
+ prompt: "In a few sentences, summarize the biggest EV market trends this quarter.",
+ },
+ {
+ displayText: "Pricing strategy tips",
+ prompt: "List five quick tips for pricing a new electric vehicle competitively.",
+ },
{
displayText: "Quarterly deck",
prompt: "Create a short presentation about our Q2 results with three slides.",
diff --git a/packages/openui-cli/src/templates/openui-chat/.gitignore b/packages/openui-cli/src/templates/openui-self-hosted/.gitignore
similarity index 100%
rename from packages/openui-cli/src/templates/openui-chat/.gitignore
rename to packages/openui-cli/src/templates/openui-self-hosted/.gitignore
diff --git a/packages/openui-cli/src/templates/openui-chat/README.md b/packages/openui-cli/src/templates/openui-self-hosted/README.md
similarity index 81%
rename from packages/openui-cli/src/templates/openui-chat/README.md
rename to packages/openui-cli/src/templates/openui-self-hosted/README.md
index 03a161d8b..12f6d78af 100644
--- a/packages/openui-cli/src/templates/openui-chat/README.md
+++ b/packages/openui-cli/src/templates/openui-self-hosted/README.md
@@ -1,4 +1,4 @@
-This is an [OpenUI](https://openui.com) Agent Chat project bootstrapped with [`openui-cli`](https://openui.com/docs/chat/quick-start).
+This is an [OpenUI](https://openui.com) Self Hosted Chat project bootstrapped with [`openui-cli`](https://openui.com/docs/chat/quick-start).
## Getting Started
diff --git a/packages/openui-cli/src/templates/openui-chat/eslint.config.mjs b/packages/openui-cli/src/templates/openui-self-hosted/eslint.config.mjs
similarity index 100%
rename from packages/openui-cli/src/templates/openui-chat/eslint.config.mjs
rename to packages/openui-cli/src/templates/openui-self-hosted/eslint.config.mjs
diff --git a/packages/openui-cli/src/templates/openui-chat/next.config.ts b/packages/openui-cli/src/templates/openui-self-hosted/next.config.ts
similarity index 100%
rename from packages/openui-cli/src/templates/openui-chat/next.config.ts
rename to packages/openui-cli/src/templates/openui-self-hosted/next.config.ts
diff --git a/packages/openui-cli/src/templates/openui-chat/package.json b/packages/openui-cli/src/templates/openui-self-hosted/package.json
similarity index 95%
rename from packages/openui-cli/src/templates/openui-chat/package.json
rename to packages/openui-cli/src/templates/openui-self-hosted/package.json
index 023d1d595..71499dbd6 100644
--- a/packages/openui-cli/src/templates/openui-chat/package.json
+++ b/packages/openui-cli/src/templates/openui-self-hosted/package.json
@@ -1,5 +1,5 @@
{
- "name": "openui-chat",
+ "name": "openui-self-hosted",
"version": "0.1.1",
"private": true,
"scripts": {
diff --git a/packages/openui-cli/src/templates/openui-chat/postcss.config.mjs b/packages/openui-cli/src/templates/openui-self-hosted/postcss.config.mjs
similarity index 100%
rename from packages/openui-cli/src/templates/openui-chat/postcss.config.mjs
rename to packages/openui-cli/src/templates/openui-self-hosted/postcss.config.mjs
diff --git a/packages/openui-cli/src/templates/openui-chat/src/app/api/chat/route.ts b/packages/openui-cli/src/templates/openui-self-hosted/src/app/api/chat/route.ts
similarity index 100%
rename from packages/openui-cli/src/templates/openui-chat/src/app/api/chat/route.ts
rename to packages/openui-cli/src/templates/openui-self-hosted/src/app/api/chat/route.ts
diff --git a/packages/openui-cli/src/templates/openui-chat/src/app/globals.css b/packages/openui-cli/src/templates/openui-self-hosted/src/app/globals.css
similarity index 100%
rename from packages/openui-cli/src/templates/openui-chat/src/app/globals.css
rename to packages/openui-cli/src/templates/openui-self-hosted/src/app/globals.css
diff --git a/packages/openui-cli/src/templates/openui-chat/src/app/layout.tsx b/packages/openui-cli/src/templates/openui-self-hosted/src/app/layout.tsx
similarity index 91%
rename from packages/openui-cli/src/templates/openui-chat/src/app/layout.tsx
rename to packages/openui-cli/src/templates/openui-self-hosted/src/app/layout.tsx
index a7fbfb1a4..099a706e3 100644
--- a/packages/openui-cli/src/templates/openui-chat/src/app/layout.tsx
+++ b/packages/openui-cli/src/templates/openui-self-hosted/src/app/layout.tsx
@@ -2,7 +2,7 @@ import type { Metadata } from "next";
import "./globals.css";
export const metadata: Metadata = {
- title: "OpenUI Chat",
+ title: "OpenUI Self Hosted",
description: "Generative UI Chat with OpenAI SDK",
};
diff --git a/packages/openui-cli/src/templates/openui-chat/src/app/page.tsx b/packages/openui-cli/src/templates/openui-self-hosted/src/app/page.tsx
similarity index 96%
rename from packages/openui-cli/src/templates/openui-chat/src/app/page.tsx
rename to packages/openui-cli/src/templates/openui-self-hosted/src/app/page.tsx
index 612caddb6..20e22906c 100644
--- a/packages/openui-cli/src/templates/openui-chat/src/app/page.tsx
+++ b/packages/openui-cli/src/templates/openui-self-hosted/src/app/page.tsx
@@ -29,7 +29,7 @@ const llm: ChatLLM = {
export default function Home() {
return (
<div className="h-screen w-screen overflow-hidden">
- <AgentInterface llm={llm} componentLibrary={openuiLibrary} agentName="OpenUI Chat" />
+ <AgentInterface llm={llm} componentLibrary={openuiLibrary} agentName="OpenUI Self Hosted" />
</div>
);
}
diff --git a/packages/openui-cli/src/templates/openui-chat/src/library.ts b/packages/openui-cli/src/templates/openui-self-hosted/src/library.ts
similarity index 100%
rename from packages/openui-cli/src/templates/openui-chat/src/library.ts
rename to packages/openui-cli/src/templates/openui-self-hosted/src/library.ts
diff --git a/packages/openui-cli/src/templates/openui-chat/tsconfig.json b/packages/openui-cli/src/templates/openui-self-hosted/tsconfig.json
similarity index 100%
rename from packages/openui-cli/src/templates/openui-chat/tsconfig.json
rename to packages/openui-cli/src/templates/openui-self-hosted/tsconfig.json