assistant-ui セットアップ

CLI コマンド

クイック判定フロー

• 既存 Next.js アプリ (package.json が存在): npx assistant-ui@latest init を使用
• CI/エージェント/非インタラクティブシェル内の既存アプリ: npx assistant-ui@latest init --yes を使用
• 既存アプリ + 競合の強制上書き: --overwrite を追加
• 新規アプリ/空のディレクトリ: npx 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"

テンプレート:

テンプレート	説明
default	Vercel AI SDK を含むデフォルトテンプレート
minimal	最小限のスターティングポイント
cloud	クラウドベースの永続性スターター
cloud-clerk	Clerk 認証を含むクラウドベーススターター
langgraph	LangGraph スターターテンプレート
mcp	MCP スターターテンプレート

-t が省略された場合:

• インタラクティブシェル (TTY): インタラクティブテンプレートピッカーが表示されます。
• 非インタラクティブシェル (CI/エージェント): テンプレートはデフォルトで default になります。

非インタラクティブシェルでプロジェクトディレクトリが指定されない場合、create は my-aui-app を使用します。

既存 Next.js プロジェクト (init)

npx assistant-ui@latest init --yes

init コマンドは 既存プロジェクト専用 です (package.json が必須)。 プロジェクトが見つからない場合、自動的に create に転送されます。 init に --preset を渡すと、create にも転送されます (互換性パス)。

--yes フラグは非インタラクティブ実行を行います (プロンプトなし)。

レジストリコンポーネントを追加

npx assistant-ui@latest add markdown-text
npx assistant-ui@latest add thread-list

レジストリ: https://r.assistant-ui.com/{name}.json

---

テンプレートコードポリシー

CLI テンプレート (npx assistant-ui@latest create) を使用する場合、明示的に要求されない限り、生成されたコードは変更しないでください。

---

非デフォルトセットアップ

AI SDK 以外のランタイムまたは Next.js 以外のフレームワークの場合は、リファレンスファイルを参照してください:

セットアップ	ランタイムフック	リファレンス
AI SDK advanced (tools, cloud, options)	useChatRuntime	references/ai-sdk.md
スタイリングと UI のカスタマイズ (shadcn パターン)	—	references/styling.md
LangGraph エージェント	useLangGraphRuntime	references/langgraph.md
AG-UI プロトコル	useAgUiRuntime	references/ag-ui.md
A2A プロトコル	useA2ARuntime	references/a2a.md
カスタムストリーミング API	useLocalRuntime	references/custom-backend.md
既存ステート (Redux/Zustand)	useExternalStoreRuntime	references/custom-backend.md
Vite / TanStack Start	—	references/tanstack.md

---

非推奨パッケージ

@assistant-ui/styles または @assistant-ui/react-ui をインストールしないでください — 両方とも非推奨で削除されています。

---

トラブルシューティング

リファレンスファイルで説明されていない問題については、docs ウェブサイトを使用してください:

1. インデックスを取得: https://www.assistant-ui.com/llms.txt — コンパクトな目次
2. 特定のページを取得: docs URL に .mdx を付加します。例: https://www.assistant-ui.com/docs/runtimes/ai-sdk.mdx