Getting Started
Installation
Install the only ToonUI packages most apps need: core for server and react for client.
Install ToonUI with the AI SDK packages used in the recommended path:
pnpm add @toon-ui/core @toon-ui/react ai @ai-sdk/react @ai-sdk/openaiFor server-only protocol work:
pnpm add @toon-ui/coreFor React rendering only in a package that already receives model output:
pnpm add @toon-ui/reactFor a package that owns both server protocol and React rendering, without installing AI SDK packages:
pnpm add @toon-ui/core @toon-ui/reactPackage map
| Package | Use it for | Import it where |
|---|---|---|
@toon-ui/core | prompt, catalog, parser, validation, events, messages | server or shared non-React code |
@toon-ui/react | runtime, renderer, adapter, hooks | React client code |
Do not install an umbrella package. ToonUI intentionally keeps server and client imports separate.
Next step
Go to Quickstart.