Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/content/docs/agent/getting-started/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,31 @@ npm run dev

Open [http://localhost:3000](http://localhost:3000) and request an interface such as a comparison table or interactive form.

## 4. Share a preview

Deploy a Vercel preview from the project directory:

```bash tab="pnpm" tab-group="pkg"
pnpx @openuidev/cli@latest deploy
```

```bash tab="bun" tab-group="pkg"
bunx @openuidev/cli@latest deploy
```

```bash tab="yarn" tab-group="pkg"
yarn dlx @openuidev/cli@latest deploy
```

```bash tab="npm" tab-group="pkg"
npx @openuidev/cli@latest deploy
```

Allowlisted keys from `.env`, such as `OPENAI_API_KEY`, are passed to the deployment.

## What to read next

- [Deploy with the CLI](/docs/api-reference/cli#deploy)
- [Adapters and formats](/docs/agent/reference/adapters-and-formats)
- [Generative UI](/docs/agent/core-concepts/generative-ui)
- [Customize Agent Interface](/docs/agent/customize/welcome-and-starters)
Expand Down
10 changes: 10 additions & 0 deletions docs/content/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,16 @@ npx @openuidev/cli@latest create \

The generated application includes [Agent Interface](/docs/agent/getting-started/introduction) and an OpenUI Lang component library. Follow the [Agent Interface Quickstart](/docs/agent/getting-started/quickstart) to understand the generated project.

### Share a preview

From the project directory, deploy a Vercel preview without installing the Vercel CLI:

```bash
npx @openuidev/cli@latest deploy
```

See the [CLI reference](/docs/api-reference/cli#deploy) for `--prod`, `--yes`, and `--skip-env`.

## Add OpenUI to an existing application

<Cards>
Expand Down
4 changes: 3 additions & 1 deletion packages/openui-cli/src/commands/create-app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -811,9 +811,11 @@ function getStartedMessage(o: {
`> ${o.devCmd} run dev`,
].join("\n");

const deployHint = "Share a preview:\n> npx @openuidev/cli@latest deploy";

const frameworkNote = o.backendGettingStarted?.replaceAll("{{packageManager}}", o.devCmd) ?? "";

return `\n${[skillMessage.trim(), "Done!", envNote, frameworkNote, nextStep]
return `\n${[skillMessage.trim(), "Done!", envNote, frameworkNote, nextStep, deployHint]
.filter(Boolean)
.join("\n\n")}\n`;
}
Expand Down
2 changes: 1 addition & 1 deletion templates/openui-cloud/overlays/langgraph/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@
"files": {
"remove": ["src/lib/tool-loop.ts"]
},
"gettingStarted": "The generated LangGraph agent runs in-process inside the Next.js `/api/chat` route and uses OpenUI Cloud as its Responses provider. `{{packageManager}} run dev` starts the app; deploy it to Vercel as-is.\nAsk \"What's the weather in Berlin?\" to exercise the included LangGraph tool."
"gettingStarted": "The generated LangGraph agent runs in-process inside the Next.js `/api/chat` route and uses OpenUI Cloud as its Responses provider. `{{packageManager}} run dev` starts the app. Share a preview with `npx @openuidev/cli@latest deploy`.\nAsk \"What's the weather in Berlin?\" to exercise the included LangGraph tool."
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@
"files": {
"remove": ["src/lib/tool-loop.ts"]
},
"gettingStarted": "The generated Vercel AI SDK route calls OpenUI Cloud Chat Completions and is deployable as a normal Next.js app on Vercel.\nAsk \"What's the weather in Berlin?\" to exercise the included AI SDK tool."
"gettingStarted": "The generated Vercel AI SDK route calls OpenUI Cloud Chat Completions. Share a preview with `npx @openuidev/cli@latest deploy`.\nAsk \"What's the weather in Berlin?\" to exercise the included AI SDK tool."
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@
},
"removeDependencies": ["openai"]
},
"gettingStarted": "The generated LangGraph agent runs in-process inside the Next.js `/api/chat` route, with your OpenAI-compatible provider as its model. `{{packageManager}} run dev` starts the app; deploy it to Vercel as-is.\nAsk \"What's the weather in Berlin?\" to exercise its native tool loop."
"gettingStarted": "The generated LangGraph agent runs in-process inside the Next.js `/api/chat` route, with your OpenAI-compatible provider as its model. `{{packageManager}} run dev` starts the app. Share a preview with `npx @openuidev/cli@latest deploy`.\nAsk \"What's the weather in Berlin?\" to exercise its native tool loop."
}
Loading