// Setup and configure assistant-ui in a project. Use when installing packages, configuring runtimes, setting up chat UI, or troubleshooting setup issues.
Update assistant-ui and AI SDK to latest versions. Detects current versions, identifies breaking changes, and executes migrations.
Guide for assistant-ui library - AI chat UI components. Use when asking about architecture, debugging, or understanding the codebase.
Guide for assistant-cloud persistence and authorization. Use when setting up thread persistence, file uploads, or authentication.
Guide for assistant-ui UI primitives - ThreadPrimitive, ComposerPrimitive, MessagePrimitive. Use when customizing chat UI components.
Guide for assistant-ui runtime system and state management. Use when working with runtimes, accessing state, or managing thread/message data.
Guide for assistant-stream package and streaming protocols. Use when implementing streaming backends, custom protocols, or debugging stream issues.
| name | setup |
| description | Setup and configure assistant-ui in a project. Use when installing packages, configuring runtimes, setting up chat UI, or troubleshooting setup issues. |
| version | 0.1.0 |
| license | MIT |
package.json exists): use npx assistant-ui@latest initnpx assistant-ui@latest init --yes--overwritenpx assistant-ui@latest create <name>-t <default|minimal|cloud|cloud-clerk|langgraph|mcp>npx assistant-ui@latest create <name> --example <example>npx assistant-ui@latest create <name> --preset <url>create)npx assistant-ui@latest create my-app -t minimal
npx assistant-ui@latest create my-app -t cloud-clerk
npx assistant-ui@latest create my-app --preset "https://www.assistant-ui.com/playground/init?preset=chatgpt"
Templates:
| Template | Description |
|---|---|
default | Default template with Vercel AI SDK |
minimal | Bare-bones starting point |
cloud | Cloud-backed persistence starter |
cloud-clerk | Cloud-backed starter with Clerk auth |
langgraph | LangGraph starter template |
mcp | MCP starter template |
When -t is omitted:
default.If no project directory is provided in a non-interactive shell, create uses my-aui-app.
init)npx assistant-ui@latest init --yes
The init command is for existing projects only (requires package.json).
If no project is found, it automatically forwards to create.
Passing --preset to init also forwards to create (compatibility path).
The --yes flag runs non-interactively (no prompts).
npx assistant-ui@latest add markdown-text
npx assistant-ui@latest add thread-list
Registry: https://r.assistant-ui.com/{name}.json
When using CLI templates (npx assistant-ui@latest create), never modify generated code unless explicitly requested.
For runtimes other than AI SDK or frameworks other than Next.js, consult the reference files:
| Setup | Runtime Hook | Reference |
|---|---|---|
| AI SDK advanced (tools, cloud, options) | useChatRuntime | references/ai-sdk.md |
| Styling and UI customization (shadcn pattern) | — | references/styling.md |
| LangGraph agents | useLangGraphRuntime | references/langgraph.md |
| AG-UI protocol | useAgUiRuntime | references/ag-ui.md |
| A2A protocol | useA2ARuntime | references/a2a.md |
| Custom streaming API | useLocalRuntime | references/custom-backend.md |
| Existing state (Redux/Zustand) | useExternalStoreRuntime | references/custom-backend.md |
| Vite / TanStack Start | — | references/tanstack.md |
NEVER install @assistant-ui/styles or @assistant-ui/react-ui — both are deprecated and deleted.
For issues not covered by the reference files, use the docs website:
https://www.assistant-ui.com/llms.txt — compact table of contents.mdx to the docs URL, e.g. https://www.assistant-ui.com/docs/runtimes/ai-sdk.mdx