# @assistant-ui/react-ink 中文文档

规范地址：https://npmcn.com/package/%40assistant-ui/react-ink/

版本：0\.0\.54
npm 元数据更新时间：2026-10-28T00:51:22.654Z
中文译文更新时间：2026-11-07T00:28:19.818Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40assistant-ui/react-ink
原文对照：https://npmcn.com/package/%40assistant-ui/react-ink/?lang=original
项目主页：https://www.assistant-ui.com/
源码仓库：https://github.com/assistant-ui/assistant-ui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.1 MB，642 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：9 个
- peer 依赖：ink \>=6，react ^19，@types/react \*
- 首次发布：2026-03-08T03:12:36.914Z
- 最新版本发布：2026-10-28T00:51:22.287Z
- 近 30 天下载量：45621（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：51（近 12 个月 51 个）

## 中文简介

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

## 安装

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

也可以使用：`pnpm add @assistant-ui/react-ink`、`yarn add @assistant-ui/react-ink`、`bun add @assistant-ui/react-ink`

## README

# `@assistant-ui/react-ink`

[![npm version](https://img.shields.io/npm/v/@assistant-ui/react-ink)](https://www.npmjs.com/package/@assistant-ui/react-ink) [![npm downloads](https://img.shields.io/npm/dm/@assistant-ui/react-ink)](https://www.npmjs.com/package/@assistant-ui/react-ink) [![GitHub stars](https://img.shields.io/github/stars/assistant-ui/assistant-ui)](https://github.com/assistant-ui/assistant-ui) ![License](https://img.shields.io/npm/l/@assistant-ui/react-ink)

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

## 安装

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

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

对于带有语法加亮的标记下渲染,也安装 [`@assistant-ui/react-ink-markdown`](https://www.npmjs.com/package/@assistant-ui/react-ink-markdown)。 。 。 .

## 使用量

```tsx
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 />);
```

## 文档

-   [开始](https://www.assistant-ui.com/docs/ink)
-   [从网络迁移](https://www.assistant-ui.com/docs/ink/migration)
-   [初级](https://www.assistant-ui.com/docs/ink/primitives)
-   [钩子](https://www.assistant-ui.com/docs/ink/hooks)

## 其他平台

-   网络 : [`@assistant-ui/react`](https://www.npmjs.com/package/@assistant-ui/react)
-   原生反应 : [`@assistant-ui/react-native`](https://www.npmjs.com/package/@assistant-ui/react-native)

## 常见问题

### @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 和提交记录判断。