assistant-ui Ink

Always consult assistant-ui.com/llms.txt for the latest API.

@assistant-ui/react-ink connects the assistant-ui runtime to Ink's terminal renderer. It shares runtime, tools, state, and AI SDK transport with web apps, but it has no DOM, CSS, or copied elements. Compose your screen from Ink's Box and Text plus the runtime aware primitives. @assistant-ui/react-ink-markdown renders assistant text as ANSI styled terminal markdown.

References

• ./references/primitives.md -- every terminal primitive namespace, its parts, scoped contexts, and the controlled TextInput
• ./references/hooks.md -- runtime, state, tool, notification, voice, and checklist hooks
• ./references/adapters.md -- file storage, attachment, and title adapters
• ./references/custom-backend.md -- local inference, local disk persistence, and backend thread ownership
• ./references/migration.md -- what transfers from a web app and what must be rebuilt for Ink

Start a terminal app

Scaffold the terminal example when starting fresh: