# @flun/flun 中文文档

规范地址：https://npmcn.com/package/%40flun/flun/

版本：8\.0\.1
npm 元数据更新时间：2026-11-01T03:55:24.213Z
中文译文更新时间：2026-11-01T04:18:33.971Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：22.5 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12\.0
- 运行依赖：1 个
- 首次发布：2026-10-31T14:14:15.710Z
- 最新版本发布：2026-11-01T03:55:24.020Z
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

Flun 生态包索引:列出全部官方包、查看用途与用法、一键打开文档;

## 安装

```sh
npm install @flun/flun
```

也可以使用：`pnpm add @flun/flun`、`yarn add @flun/flun`、`bun add @flun/flun`

## README

# @flun/flun

## 简介

Flun 生态包索引:列出全部官方包、查看用途与安装命令、一键打开文档;

收录清单见包内 `packages.json`;命令行运行 `npx @flun/flun pkgs` 可查看全部包及安装状态;

具体 API 与用法见各包自身文档,本包不重新导出子包功能;

* * *

## 特性

-   列出全部官方包,按已装/未装分组,显示描述与安装状态;
-   单包详情显示描述、安装命令与版本,已装包打开本地 `README.md`,未装包打开 npm 页面;
-   `search` 子命令按包名、描述中的关键字搜索;
-   版本双轨显示:本地已装版本与 npm 最新版本对比,可升级项标为 `旧 → 新 (最新)`;
-   联网失败或超时时降级为清单记录的版本,不中断使用;
-   npm 版本查询缓存 1 小时,`-r` 或 `--refresh` 可重新查询最新版本;
-   执行任意命令后检查本包自身是否有新版,有则提示更新命令,避免全局安装长期滞后;

* * *

## 包目录结构

随包发布的文件:

```
@flun/flun/
├── CHANGELOG.md   更新日志
├── cli.js         命令行入口(bin: flun)
├── flun.js        list / info / search / stats 四个函数
├── index.d.ts     类型声明
├── index.js       库入口,转发 flun.js 的导出
├── LICENSE        许可
├── net.js         联网查询最新版本与本地缓存
├── package.json   包配置
├── packages.json  包清单数据
└── README.md      本文件
```

* * *

## 安装前准备

### 允许安装脚本执行

本包在安装时可能触发某些依赖包的自动脚本(如 `postinstall` 等);如果你的 npm 全局配置或项目配置禁止了脚本执行(例如设置了 `ignore-scripts=true`),可能会导致安装不完整或运行时异常;

推荐在项目根目录的 `package.json` 中添加 `allowScripts` 字段,显式放行本包及其依赖的脚本:

```json
{
  "allowScripts": {
    "@flun/flun": true
  }
}
```

* * *

## 安装

项目内安装(作为开发工具):

```sh
npm i -D @flun/flun
```

全局安装(建议):

```sh
npm i -g @flun/flun # 之后使用 `flun` 查看用法

```

* * *

## 命令行

### 快速开始

```sh
npx @flun/flun pkgs
```

### 子命令

| 参数 | 作用 |
| --- | --- |
| `pkgs` | 列出全部包(按已装/未装分组) |
| `search <关键字>` | 按包名、描述中的关键字搜索 |
| `info <包名>` | 查看单包详情(已装打开本地 README,未装打开 npm 页面) |
| `stats` | 输出收录包时间、数量与最高版本 |

### 选项

| 参数 | 作用 |
| --- | --- |
| `-r`, `--refresh` | 重新查询 npm 最新版本(忽略 1 小时缓存,仅对 `pkgs` 与 `info` 生效) |

无参数、`help`、`-h`、`--help` 输出帮助;全局安装后把 `npx @flun/flun` 换成 `flun`;

* * *

## 函数方式

导入 `list`、`info`、`search`、`stats` 四个函数:

```js
import { list, info, search, stats } from '@flun/flun';

list();                // 全部包的元数据数组
info('@flun/mailer');  // 单包详情,不存在返回 null
search('ssl');         // 按关键字搜索,返回匹配的包列表;
stats();               // 返回收录包时间、收录包数量与收录最高版本;
```

四个库函数只读取包内 `packages.json`,不联网;CLI 会查询 npm registry 显示最新版本,带 1 小时缓存, 联网失败或单次请求超时(5 秒)时降级为本地版本并标注 `(离线)`;

* * *

## 许可证

ISC

* * *

## 贡献

-   主页:[npm 包页面](https://www.npmjs.com/package/@flun/flun#readme)
-   源码:[GitHub](https://github.com/OpenFlun/flun)
-   中国:[gitee](https://gitee.com/OpenFlun/flun.git)
-   问题反馈:[Issues](https://github.com/OpenFlun/flun/issues)

## 常见问题

### @flun/flun 是什么？

Flun 生态包索引:列出全部官方包、查看用途与用法、一键打开文档;

### 如何安装 @flun/flun？

在项目目录运行 npm install @flun/flun，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 flun，可以用 npx flun 直接运行。

### @flun/flun 支持 TypeScript 吗？

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

### @flun/flun 支持 ESM 还是 CommonJS？

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

### @flun/flun 需要什么版本的 Node\.js？

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

### @flun/flun 可以商用吗？

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

### @flun/flun 还在维护吗？

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