项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 13025
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- Node.js 环境(README 使用 npx/npm 命令)
- 使用 npm 作为包管理器
- 已有 React 项目,或通过 CLI 自动生成的 Next.js 项目
- 需要 Vercel AI SDK 配合 useChatRuntime 使用
安装与启动步骤
-
1创建新项目
在空目录执行 CLI,自动脚手架出一个带聊天界面的 Next.js 应用,这是官方推荐的最快路径。
npx assistant-ui@latest create -
2接入已有项目
已有 Next.js 项目时改用 init,将带样式的聊天组件加入现有工程,而不是新建项目。
npx assistant-ui@latest init -
3手动安装依赖
不想用 CLI 时,直接安装核心 React 包与 Vercel AI SDK 适配包,组件样式需自行接入。
npm install @assistant-ui/react @assistant-ui/ai-sdk -
4编写聊天组件
在客户端组件中调用 useChatRuntime 创建 runtime,再用 Provider 包裹 Thread 组件渲染界面。
"use client"; import { AssistantRuntimeProvider } from "@assistant-ui/react"; import { useChatRuntime } from "@assistant-ui/ai-sdk"; import { Thread } from "@/components/assistant-ui/elements/thread.aui"; export function Chat() { const runtime = useChatRuntime(); return ( <AssistantRuntimeProvider runtime={runtime}> <Thread /> </AssistantRuntimeProvider> ); } -
5更换运行时
useChatRuntime 默认对接 Vercel AI SDK;要接自建后端可换成其他 runtime 或自定义 runtime。
如何确认成功
组件渲染出 Thread 聊天界面且无报错,发送消息后能通过所选 runtime 返回流式回复。
常见问题
Q:create 和 init 有什么区别?
A:create 用于生成一个全新的 Next.js 项目;init 用于向已有的现有项目添加 assistant-ui 的带样式组件。
Q:可以不用 CLI 吗?
A:可以。README 提供了直接安装方式:npm install @assistant-ui/react @assistant-ui/ai-sdk,然后自行在代码中接入组件。
Q:怎么对接自己的后端模型服务?
A:把 useChatRuntime 换成 useLangGraphRuntime、useDataStreamRuntime,或按需求实现任意自定义 runtime。
Q:需要配置模型 API Key 吗?
A:README 未涉及密钥配置,模型接入由 Vercel AI SDK 一侧负责,请参考对应的 AI SDK 文档。
注意事项
- README 未给出 Node.js 版本要求,建议使用较新的 LTS 版本。
- 示例中 Thread 的路径 @/components/assistant-ui/elements/thread.aui 由 CLI 生成,手动安装时需自行确认路径。
- README 未提供端口、环境变量等启动参数说明,具体以脚手架生成的项目为准。
核心亮点
- 基于 Radix UI 和 shadcn,组件美观且无障碍支持完善
- 与 Vercel AI SDK 深度集成,流式输出和工具调用开箱即用
- 提供 Copilot 模式和可扩展的组件架构,适合复杂业务场景
不足之处
- 与 Vercel AI SDK 强绑定,迁移到其他 AI 框架成本较高
- 文档和示例相对较少,高级定制需深入阅读源码
适用场景
- 快速构建 AI 聊天机器人前端界面
- 在 React 应用中集成 Copilot 式辅助功能
- 需要流式响应和工具调用的对话式 AI 产品
替代项目
chatbot-ui、react-chat-elements、stream-chat-react
同类项目推荐
voice-ui-kit
开源
用 React 组件和 hooks 快速搭出语音 AI 应用界面
Components, hooks and template apps for building React voice AI applications quickly···
langroid
开源
用多智能体编程,轻松编排 LLM 完成复杂任务
Harness LLMs with Multi-Agent Programming
dexter
开源
把生产级 LLM 工具链直接搬进你的项目
LLM tools used in production at Dexa
ai-rulez
开源
一套规则,自动生成 19+ AI 工具配置,告别重复劳动
Author, generate, validate and govern AI agent rules, skills, plugins and MCP config···
tree-of-thoughts
开源
让大模型先想多步再选最优,推理正确率提升70%
Plug in and Play Implementation of Tree of Thoughts: Deliberate Problem Solving with···
rpd
开源
快速搭建节点式可视化编程界面,拖拽连线即所得。
:ok_hand: A Minimal Engine for creating Node-Based Visual Programming User Interface···
ai-sdk-provider-codex-cli
开源
用ChatGPT订阅白嫖GPT-5,接入AI SDK应用
Vercel AI SDK community provider for Codex CLI - Use Plus/Pro Subscription via spawn···
ritajs
开源
在创意编程中轻松玩转文本处理与生成
RiTa for JavaScript
codex-profiles
开源
一键切换 Codex CLI 账号配置,多环境开发不折腾。
Save, list, and switch Codex CLI accounts fast.
