@assistant-ui/react-ink

中文文档
0.0.54发布于 2026/10/28MITTypeScriptES Module构建来源已验证近 30 天下载 4.6万

对助手- ui 的反相墨( terminal UI) 绑定

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 文档
  4. 其他平台

@assistant-ui/react-ink

npm version npm downloads GitHub stars License

墨迹 绑定的助手。 与运行时间、适配器和工具相同的可编译的、无样式的终端原始软件 @assistant-ui/react,可以不重写后端代码而发送 CLI 聊天 UI .

安装

要求反应19和墨水6或更新.

npm install @assistant-ui/react-ink ink react

对于带有语法加亮的标记下渲染,也安装 @assistant-ui/react-ink-markdown。 。 。 .

使用量

import { render, Box, Text } from "ink";
import {
  AssistantRuntimeProvider,
  useLocalRuntime,
  ThreadPrimitive,
  ComposerPrimitive,
  useAuiState,
  type ChatModelAdapter,
} from "@assistant-ui/react-ink";

const adapter: ChatModelAdapter = {
  async *run({ messages }) {
    yield { content: [{ type: "text", text: "Hello from AI!" }] };
  },
};

const Message = () => {
  const message = useAuiState((s) => s.message);
  const text = message.content.find((p) => p.type === "text")?.text ?? "";
  return (
    <Box marginBottom={1}>
      <Text color={message.role === "user" ? "green" : "blue"}>
        {message.role === "user" ? "You: " : "AI: "}
      </Text>
      <Text>{text}</Text>
    </Box>
  );
};

const App = () => {
  const runtime = useLocalRuntime(adapter);
  return (
    <AssistantRuntimeProvider runtime={runtime}>
      <ThreadPrimitive.Root>
        <ThreadPrimitive.Messages>{() => <Message />}</ThreadPrimitive.Messages>
        <Box borderStyle="round" paddingX={1}>
          <Text>{"> "}</Text>
          <ComposerPrimitive.Input submitOnEnter placeholder="Message..." autoFocus />
        </Box>
      </ThreadPrimitive.Root>
    </AssistantRuntimeProvider>
  );
};

render(<App />);

文档

其他平台

版本与发布记录

@assistant-ui/react-ink 共发布 51 个版本,首次发布于 2026/03/08;过去 12 个月发布了 51 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.0.54latest2026/10/2810 天前
0.0.532026/10/2315 天前
0.0.522026/10/2018 天前
0.0.512026/10/1622 天前
0.0.502026/10/1325 天前
0.0.492026/10/0929 天前

关于 @assistant-ui/react-ink 的常见问题

@assistant-ui/react-ink 是什么?

对助手- ui 的反相墨( terminal UI) 绑定

如何安装 @assistant-ui/react-ink?

在项目目录运行 npm install @assistant-ui/react-ink,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:ink(>=6)、react(^19)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@assistant-ui/react-ink 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@assistant-ui/react-ink 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@assistant-ui/react-ink 可以商用吗?

@assistant-ui/react-ink 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@assistant-ui/react-ink 的下载量有多少?

根据 npm 官方下载统计,@assistant-ui/react-ink 在 2026/10/07 – 2026/11/05 这 30 天内被下载 45,621 次,日均约 1,521 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@assistant-ui/react-ink 还在维护吗?

最新版本 0.0.54 发布于 2026/10/28(10 天前);至今共发布 51 个版本,其中过去 12 个月发布了 51 个;首次发布于 2026/03/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。