# @abapify/adt-tui 中文文档

规范地址：https://npmcn.com/package/%40abapify/adt-tui/

版本：0\.4\.34
npm 元数据更新时间：2026-11-02T23:19:37.579Z
中文译文更新时间：2026-11-06T21:14:21.559Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40abapify/adt-tui
原文对照：https://npmcn.com/package/%40abapify/adt-tui/?lang=original
项目主页：https://github.com/abapify/adt-cli/tree/main/packages/adt-tui#readme
源码仓库：https://github.com/abapify/adt-cli

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

- 包体积（解压后）：75.1 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：7 个
- peer 依赖：@abapify/adt-client 0\.4\.33
- 首次发布：2026-04-20T21:12:49.859Z
- 最新版本发布：2026-11-02T23:19:37.243Z
- 近 30 天下载量：2328（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：31（近 12 个月 31 个）

## 中文简介

ADT 终端 UI 组件 - 有墨水的基于页面导航

## 安装

```sh
npm install @abapify/adt-tui
```

也可以使用：`pnpm add @abapify/adt-tui`、`yarn add @abapify/adt-tui`、`bun add @abapify/adt-tui`

## README

# @abapify/adt-tui (英语)

ADT 的终端 UI 原始文件, 以 [墨迹](https://github.com/vadimdemedes/ink) 和反应。 提供一个基于页面的小型导航框架——a `Navigator`, (中文(简体) ), (单位:千美元) `PageRenderer`,一个超媒体链接解析器和一个通用页面,即其他 软件包和 CLI 命令用于在 终端.

[![npm](https://img.shields.io/npm/v/%40abapify%2Fadt-tui.svg)](https://www.npmjs.com/package/@abapify/adt-tui)

## 安装

```bash
npm i @abapify/adt-tui
# or
bun add @abapify/adt-tui
```

`@abapify/adt-client` 是同伴依赖,必须由主机安装.

## 使用量

从 CLI 命令启动 TUI, 在初始获取函数中通过 (通常由 ADT 客户端支持) 并启动 URI :

```ts
import { run } from '@abapify/adt-tui';

await run({
  fetch: (uri) => client.request(uri),
  startUrl: '/sap/bc/adt/repository/nodestructure',
});
```

或者直接在自己的"墨子"应用软件里 写出原始人:

```tsx
import { App, Navigator, NavigationProvider } from '@abapify/adt-tui';
import { render } from 'ink';

render(
  <NavigationProvider>
    <App fetch={fetchFn} startUrl="/sap/bc/adt/discovery" />
  </NavigationProvider>,
);
```

自定义页面执行 `PageComponent` 合同和返回a `PageResult` 描述下一步要遵循的链接; 框架需要 关心历史,渲染, 和回航.

## 在单簧管中的作用

-   基于墨水的 TUI 原始层:它拥有 `Navigator`, (中文(简体) ), `PageRenderer`, (中文(简体) ), 导航上下文、超媒体反应解析器和共享 页面/路由类型.
-   以交互式方式使用 `adt-cli` 命令和实验;故意 包含除链接解析外没有 ADT 特定业务逻辑, 所以命令 带他们自己的页面.
-   取决于 `@abapify/adt-contracts` 用于响应打字并保存 `@abapify/adt-client` 作为同级依赖,以避免重复 在主机应用程序中的客户端.

## 相关

-   [生化/adt-cli单体](https://github.com/abapify/adt-cli)
-   [完整文档](https://adt-cli.netlify.app/)

## 许可证

麻省理工学院

## 常见问题

### @abapify/adt-tui 是什么？

ADT 终端 UI 组件 - 有墨水的基于页面导航

### 如何安装 @abapify/adt-tui？

在项目目录运行 npm install @abapify/adt-tui，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@abapify/adt-client（0\.4\.33）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @abapify/adt-tui 支持 TypeScript 吗？

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

### @abapify/adt-tui 支持 ESM 还是 CommonJS？

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

### @abapify/adt-tui 可以商用吗？

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

### @abapify/adt-tui 的下载量有多少？

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

### @abapify/adt-tui 还在维护吗？

最新版本 0\.4\.34 发布于 2026/11/03（4 天前）；至今共发布 31 个版本，其中过去 12 个月发布了 31 个；首次发布于 2026/04/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。