# @fungi\.computer/lantern 中文文档

规范地址：https://npmcn.com/package/%40fungi.computer/lantern/

版本：0\.4\.2
npm 元数据更新时间：2026-11-08T12:21:41.532Z
中文译文更新时间：2026-11-15T19:06:23.807Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fungi.computer/lantern
原文对照：https://npmcn.com/package/%40fungi.computer/lantern/?lang=original
项目主页：https://github.com/fungi-computer/lantern#readme
源码仓库：https://github.com/fungi-computer/lantern

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

- 包体积（解压后）：34.6 kB，16 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：3 个
- 首次发布：2026-10-16T18:03:33.799Z
- 最新版本发布：2026-11-08T12:21:41.271Z
- 近 30 天下载量：5276（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

共享真菌终端词签、 Clack 交互和进度

## 安装

```sh
npm install @fungi.computer/lantern
```

也可以使用：`pnpm add @fungi.computer/lantern`、`yarn add @fungi.computer/lantern`、`bun add @fungi.computer/lantern`

## README

# 灯手( R)`@fungi.computer/lantern`(中文(简体) )

灯会提供终端文字标记,提示和进步. 大多数人想要 [牡蛎](https://docs.fungi.computer/oyster/) 运行 Apps 或 [Shi](https://docs.fungi.computer/shiitake/) 以运行特工.

Fungi 命令行工具共享单词标记、 提示和进度 消息,所以每个命令不重建终端,看起来和感觉是一样的 从零开始演示文稿。 它处理终端演示. 每个命令都有 它自己的工作, 证书,坚持,和谈话状态.

## 安装或设置

使用节点24或更新.

```sh
npm install @fungi.computer/lantern
```

包船无害环境管理仅取决于 `@clack/core`, (中文(简体) ), `@clack/prompts`,以及 [脚尖](https://docs.fungi.computer/stipe/) 用于终端颜色,全部安装 自动。 导入 `@fungi.computer/lantern` 用于节点命令行工具,或 `@fungi.computer/lantern/banner` 在不导入 Clack 的情况下制作横幅 提示或节点流.

## 快开始

这个示例使用非交互式的 CLI , 因此是进步和核对表 消息到所提供的输出流 :

```ts
import { Cli } from "@fungi.computer/lantern";

const cli = new Cli({ brand: "vishnu", interactive: false });
cli.welcome("Build a game");
await cli.task("Building", async (update) => {
  update("Checking the project");
  return "ready";
});
cli.checklist()("project", true, "ready");
```

终端测试进行横幅渲染、管道输入行为,以及 非交互式任务输出 [`test/terminal.test.ts`](https://npmcn.com/package/%40fungi.computer/lantern/test/terminal.test.ts)。 。 。 .

## 核心概念

`Cli` 从 TTY 输入和输出中检测交互性, 除非呼叫者通过 `interactive`。它接受可选的输入、输出和终端宽度从而接受主机 可以控制提示和消息的去向. `welcome`, (中文(简体) ), `info`, (中文(简体) ), `step`, (中文(简体) ), `outro`, (中文(简体) ), `cancel`, (中文(简体) ), `task`,以及 `checklist` 提供共同的介绍。 任务停止 旋转成功。 失败的任务重排原错误 。 当旋转器是 中,它显示一个没有出错细节的通用失败消息.

在非交互模式下,普通信件被写成文本并 `confirm` 返回时 `false`。 。 。 . `text`, (中文(简体) ), `password`, (中文(简体) ), `select`,以及 `search` 扔是因为他们 需要一个交互式终端. `task` 报告进展为平线 动画旋转器.

`search` 接受带有标签、描述和可选组的顺序选择 名称。 它显示分组标题, 可以崩溃一个分组后面的计数 披露行。 打字搜索每一个选择,包括崩溃的选择. 输入 扩展披露或选择选择。 呼叫者拥有目录和组 成员。 Clack拥有输入,导航和取消功能.

`renderBanner` 是浏览器安全渲染的入口。 它选择一个品牌 用于交互式终端的宽或紧凑的艺术,以及用于管道的平面品牌标签 或无色输出. 60栏以下的宽度在有紧凑艺术的情况下使用; 计算机以狭长的宽度省略了它的艺术. 设定 `rawPty: true` 写入时 直接到原始的伪地来接收 CRLF 线尾.

## API 参考

见生成 [灯源 API 参考](https://npmcn.com/package/%40fungi.computer/lantern/docs/api/index.md) 编辑 [横幅引用](https://npmcn.com/package/%40fungi.computer/lantern/docs/api/banner.md)编辑 `./banner` 进口 `renderBanner` 和艺术弦.

## 实例和检查

现有的终端测试涵盖横幅宽度和颜色行为, 原始 PTY 线 结束、 立即拒绝管道输入以及非交互任务/检查列表 留言。 运行方式:

```sh
pnpm --filter @fungi.computer/lantern test
```

## 限制和错误

Lantern不运行命令或决定工作是否成功. 打电话的人 提供任务并拥有结果。 非交互任务打印不失败 抛出时行. 非互动确认总是下降,并迅速 可消耗管道输入的方法拒绝运行。 使用明确的命令 自动化选项.

横幅渲染器选择已有的艺术并用斯提普的语义来包装 调色板。 它不启动外壳 或自己的终端问候时间或 重接行为.

## 贡献和许可证

绿灯侠获得麻省理工学院许可. 见 [`LICENSE`](https://npmcn.com/package/%40fungi.computer/lantern/LICENSE)。 。 。 .

## 常见问题

### @fungi\.computer/lantern 是什么？

共享真菌终端词签、 Clack 交互和进度

### 如何安装 @fungi\.computer/lantern？

在项目目录运行 npm install @fungi\.computer/lantern，或使用 pnpm add / yarn add / bun add。

### @fungi\.computer/lantern 支持 TypeScript 吗？

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

### @fungi\.computer/lantern 支持 ESM 还是 CommonJS？

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

### @fungi\.computer/lantern 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @fungi\.computer/lantern 可以商用吗？

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

### @fungi\.computer/lantern 的下载量有多少？

根据 npm 官方下载统计，@fungi\.computer/lantern 在 2026/10/16 – 2026/11/14 这 30 天内被下载 5,276 次，日均约 176 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fungi\.computer/lantern 还在维护吗？

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