# @flood-md/cli 中文文档

规范地址：https://npmcn.com/package/%40flood-md/cli/

版本：0\.2\.13
npm 元数据更新时间：2026-11-13T22:47:29.594Z
中文译文更新时间：2026-11-15T00:49:18.339Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：21.6 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.12\.0
- 运行依赖：1 个
- 首次发布：2026-10-22T11:16:48.925Z
- 最新版本发布：2026-11-13T22:47:29.184Z
- 近 30 天下载量：2959（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

连接洪水到 React 和 Next.js 项目 .

## 安装

```sh
npm install @flood-md/cli
```

也可以使用：`pnpm add @flood-md/cli`、`yarn add @flood-md/cli`、`bun add @flood-md/cli`

## README

# @flood-md/cli (英语)

`npx @flood-md/cli init [--dry-run]` 连接已有的 React/Next.js npm 工程. `npx @flood-md/cli doctor` 检查软件包版本和代理文件存在.

0.2.11版本增加了只读的JSON发现. 使用 CLI 版本匹配 ground.json; 来源可用性并不意味着候选人被公布.

```sh
npx @flood-md/cli@0.2.13 info
npx @flood-md/cli@0.2.13 catalog --kind workflow --group composition
npx @flood-md/cli@0.2.13 read component:data-table
npx @flood-md/cli@0.2.13 read recipe:table-bulk-actions
```

信息区分连接、 捆绑、 版本匹配和缺少包 各州。 分类/读取 拒绝不匹配或不完整的连接设施 . 所有三个命令都返回 JSON;失败返回 Stderr 和 a 的结构化 JSON 非零退出代码。 它们不安装、修改主机文件或获取远程向导. Npx 跑取器本身可以获取明确选中的软件包 .

分类过滤器按种类,组和字元数据搜索. 默认页面包含 最多12个条目; -- 限制接受在16 KiB产出预算范围内的1-50。 跟随 下一个目录; 更改的查询或目录将取消旧光标。 读取返回 一个已知的ID,默认最多为一万个Unicode代码点(最多为4万个). 使用 -- offset来完成指令的下一个 Offset; --links- offset pages 单独的可选链接。 所要求的先决条件在要求中是明确的.

复制指南默认为项目自有内容,按来源、定制进行识别 和散开。 -- source package 比较 canonical内容而不覆盖. 缺少/链接的项目副本显然失效。 修改后的洪水/ catalog.json 无法重定向读取 。 见 [代理知识](https://npmcn.com/package/docs/agent-knowledge.md) 对完整的协议和限制.

需要22.12+节点. 安装匹配符号、反应和代理包; 创建 ground.json和匹配代理单上列出的每个自有指南:DESIGN.md, 规则.json 和 express.json 在洪水/下,加上 SKILL.md 和重点参考 .代理人/技能/洪水/水/ 6.2.3版本包括扩大的捆绑和 间隔参考。 拒绝现有自有文件或链接的目的地. 不重写源代码,客户端设置或AGENTS.md. 输入后, 导入 @ flood- md/ react/ style. css 一次在应用程序根上 . 在 FloodRoot 从 @flood- md/ react 中环绕新界面以选择黑暗 基础简介. 为匹配的 API 读取已安装的洪水/ DESIGN. md . 读取任务/ 源/ 检查矩阵中的技能路径参考 。 医生检查 完整的指南集和软件包对齐; 它不验证应用程序 行为,CSS进口或代理遵守. 合并定制指南升级 故意; 它没有覆盖模式.

Init和医生拒绝相关项目-课程的祖先。 还需要 常规无链接软件包.json(包括无硬链接),验证其项目 对象和 react 依赖,并在自定义写入前重新检查 npm 之后的路径. 这些检查没有沙盒 npm 或停止外部进程从竞速文件系统 更改; 运行仅安装在信任的工程中并检查 npm 失败 .

## 常见问题

### @flood-md/cli 是什么？

连接洪水到 React 和 Next\.js 项目 \.

### 如何安装 @flood-md/cli？

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

### @flood-md/cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/flood-md\_\_cli 是否存在。

### @flood-md/cli 支持 ESM 还是 CommonJS？

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

### @flood-md/cli 需要什么版本的 Node\.js？

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

### @flood-md/cli 可以商用吗？

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

### @flood-md/cli 的下载量有多少？

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

### @flood-md/cli 还在维护吗？

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