wehub-resource-sync
e30e75b5d4
Changesets / Create Version PR (push) Has been cancelled
Deploy Shadcn Registry / Deploy Production (push) Has been cancelled
Template Metrics / LOC + Bundle Size (push) Has been cancelled
Code Quality / Oxlint + Oxfmt (push) Has been cancelled
Code Quality / Template Sync (push) Has been cancelled
Code Quality / Build Changed Packages (push) Has been cancelled
Code Quality / Test Changed Packages (push) Has been cancelled
Deploy Expo Example / Deploy Production (push) Has been cancelled
Deploy Ink Example / Deploy Production (push) Has been cancelled
Python Tests / pytest (assistant-stream, 3.10) (push) Has been cancelled
Python Tests / pytest (assistant-stream, 3.12) (push) Has been cancelled
Python Tests / pytest (assistant-ui-sync-server-api, 3.10) (push) Has been cancelled
Python Tests / pytest (assistant-ui-sync-server-api, 3.12) (push) Has been cancelled
35 lines
1.7 KiB
Markdown
35 lines
1.7 KiB
Markdown
# `create-assistant-ui`
|
|
|
|
[](https://www.npmjs.com/package/create-assistant-ui)
|
|
[](https://www.npmjs.com/package/create-assistant-ui)
|
|
[](https://github.com/assistant-ui/assistant-ui)
|
|
|
|
Scaffold a new assistant-ui project from a chosen template (default AI SDK, minimal, cloud, langchain, MCP, Eve, and more).
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
npm create assistant-ui my-app
|
|
pnpm create assistant-ui my-app
|
|
yarn create assistant-ui my-app
|
|
bunx create-assistant-ui my-app
|
|
```
|
|
|
|
This wraps the `assistant-ui create` command from the [`assistant-ui` CLI](https://www.npmjs.com/package/assistant-ui). Pass `-t <template>` to pick a starter, or `--preset <url>` to scaffold from an `assistant-ui.com` playground link.
|
|
|
|
## Templates
|
|
|
|
| Name | Description |
|
|
| -------------- | ---------------------------------------------------------- |
|
|
| `default` | Next.js + Vercel AI SDK (the recommended starting point). |
|
|
| `minimal` | Smallest possible Next.js + assistant-ui setup. |
|
|
| `cloud` | Default template plus Assistant Cloud thread persistence. |
|
|
| `cloud-clerk` | Cloud template with Clerk authentication. |
|
|
| `langchain` | Next.js + LangGraph agent via the react-langchain adapter. |
|
|
| `mcp` | Next.js + an MCP server integration. |
|
|
| `eve` | Next.js + Eve agent backend. |
|
|
|
|
## Documentation
|
|
|
|
Full template list and flag reference at [assistant-ui.com/docs/cli](https://www.assistant-ui.com/docs/cli).
|