@hawkeyexl/manni

中文文档
4.28.0发布于 2026/11/02MITTypeScriptES Module构建来源已验证近 30 天下载 7458

用于检查文档的命令行 . manni meta 验证文档元数据(Markdown frontmatter and more)相对于为CI所建的JSON Schema的存在和格式. 原为多克米塔.

中文使用文档
文档目录9 节
  1. 安装
  2. 来自多克米塔?
  3. 快开始
  4. 在CI中运行
  5. 填漏的东西
  6. 支持的格式
  7. 文档
  8. 捐款
  9. 许可证

马尼

用于检查文档的命令行 . manni meta 验证 存在和格式 文件元数据 贾森 司马,为CI而建. 发表于 docmeta 最高为4.13.1;见 来自多克米塔。 。 。 .

npm CI node license

manni meta 检查文档中的元数据( Markdown 前题及更多) 对抗一个或一个以上的JSON Schemas. 核查所需字段是否存在 并正确格式化:a type,一个ISO 8601 timestamp一个URI resource。 不判断传教品的质量。 它载着45人 内置 计划他们 覆盖内容词汇,例如: 打开知识格式 (OKF) (英语), (中文(简体) ), 税制, (中文(简体) ), 好医生 项目,则 七项行动 模式。它们也涵盖前题 现场发电机合同,例如 多龙 3.10,雨果,杰基尔,和MkDocs Material. 26个是曼尼自己的元数据 词汇和严格的上下文 运行 manni meta schemas 全文 列表中选择一个选项。 接下来 clig.dev (英语) 常规并返回非零 当验证失败时退出代码( 加上可选的 GitHub 说明) .

也可以这样 填写 缺少的元数据,所以通过一个现有 docset 的标准不是一个数据输入项目.

安装

npm install -g @hawkeyexl/manni
# or run it without installing:
npx @hawkeyexl/manni meta validate "**/*.md"

需要节点.js 24或后.

一旦一个存储器设置了一些工具, manni status 说在其中 游戏和 manni check 把他们都当作一扇门 在克劳德代码 manni 插件在每次编辑代理后都会运行相同的检查 。 安装它 与 claude plugin marketplace add hawkeyexl/manni,则 claude plugin install manni@manni。见 每张支票都开门 财务报告和审定财务报表 保持代理文件绿色。 。 。 .

来自多克米塔?

元数据工具曾经是整个软件包. 三件事改变了:

  • 指挥所. docmeta validate … 现在 manni meta validate …编辑 软件包仍然安装 docmeta 运行同一程序的 bin, 所以 现有脚本在移动时继续工作.
  • 配置文件 . manni.config.yaml中,每个工具共享 家族,其中元数据工具的密钥位于 meta:A级 docmeta.config.yaml 仍然读取,并附有警告.
  • GitHub行动. uses: hawkeyexl/manni@v4 现在运行 manni check, (中文(简体) ), 每次检查都设置好了 添加 command: meta validate 要运行 单凭元数据检查,加上它之前的输入.

改名改变了一切 退出代码、输出格式和 方案 API 结转,内置计划及其出版情况也是如此 URLs (英语). 旧的 …/docmeta/schemas/ URL保留服务并解析下线.

快开始

点 manni meta validate 在一个文件,一个目录(递归行走),或者一个 glob。 没有 --schema,它以默认的11个内置计划进行验证。 OKF 计划需要 type,而曼尼核心词汇要求 title 财务报告和审定财务报表 description。 。 。 . passo-uno:seven-action:1.0 而其他8个曼尼词汇则只检查一个字段,当一页带有它时.

manni meta validate docs/intro.md
✗ docs/intro.md
    (root)      must have required property 'type'                  [google:okf:0.1]
    (root)      must have required property 'description'           [manni:core:1.0.0]
    /timestamp  must match format "date-time"             (line 9)  [google:okf:0.1]

1 file checked, 0 passed, 1 failed, 0 errors

干净的运行出口 0; 验证失败退出 1; 操作出错( 无输入, 未知计划, 分析出错) 退出 2。 。 。 .

一个配置 meta.schemas 添加到默认集中,以及 meta.defaults: false 让他们取代它. meta.register 以它们命名自己的计划 $id,以及 meta.strict: true 堆放每个严格版本的底部。 这个 配置参考 每把钥匙都有.

在CI中运行

在 GitHub 动作上,使用被包的动作. 它设置了节点,锁定CLI 运行 manni check,作为内置的 PR 说明:

- uses: actions/checkout@v7
  with:
    fetch-depth: 0
- uses: hawkeyexl/manni@v4

command: 运行任意一个 manni 命令 meta validate每一个 输入在 行动 参考文献其他项目 平台直接运行 CLI. 这个 中情局 食谱 掩护GitLab CI, 詹金斯,还有其他的.

为了在他们到达CI之前抓住问题,Manni meta出版 承诺前 钩. 整个配置是三个 线条,且文件匹配模式来自扩展名manni meta 而不是手写:

repos:
  - repo: https://github.com/hawkeyexl/manni
    rev: v4.28.0
    hooks:
      - id: manni-meta

填漏的东西

manni meta fill 推断元数据属性 您的策略要求的只有一页 并写回它所信任的价值观。 这是 快速清理一个从未执行元数据的回购的积压.

manni meta fill docs/ --dry-run     # preview; writes nothing
manni meta fill docs/               # apply
✓ docs/intro.md
    /description  A tour of the CLI and its four commands.  0.91
    below 0.7: /resource 0.38

anthropic/claude-sonnet-4-5 · Threshold 0.7 · 1 file · 1 field written · 1 skipped

自信是最后一个大门,不是唯一的大门。 提案必须首先满足 目标属性本身的子schema。 它必须命名一个财产 你的计划申报, ,它必须让文档在合并后仍然有效。 只有这样 --confidence (默认) 0.7适用。 跳过并报告以下值 以名为相. 他们从来没有写过一个警告, 而且分数本身从来没有 到达您的文档.

fill 默认情况下写到原地,所以运行在一棵干净的树上并审查 d.

它通过检测来选择一个LLM提供者. 命令是 ANTHROPIC_API_KEY, (中文(简体) ), 接下来 OPENAI_API_KEY,然后是一个 claude 运行的CLI,然后一个本地模型 不需要任何证书。 也就是说,它的工作 与你拥有的,它 报告它使用的供应商。 过 --provider 以针一. 这是值得的 做在CI里。 左手去探测,一个失去钥匙的跑者 回到当地 模型,并下载它 而不是失败的构建.

过 --local 当文档不能离开机器时。 它运行推论 设备 llama-cpp 财务报告和审定财务报表 覆盖任何配置名称的提供者, (中文(简体) ), 说它放哪一个。 它从来不选 claude 运行的 CLI 在本地,而其推论却并非如此。 见 fill 参考文献 每笔 以及当地退缩的代价.

支持的格式

Markdown, MDX, AsciiDoc, reStructuredText, XML(包括DITA主题和地图),,, 还有HTML。 运行 manni meta schemas 以列出内置的策略,每个支持 格式,以及哪种格式 fill 可以写回.

fill 写信给他们所有人。 它使数值的确切字符范围相接 而不是重排文件序列。 评论、实体拼写、属性 秩序 缩合 和DOCTYPE 都幸免于难.

文档

文件网站的完整指南、食谱和参考资料实况:

https://hawkeyexl.github.io/manni/meta/* (英语)* 联合国

音轨它包含什么
开始吧安装并运行您的第一次验证 .
设置验证站立验证以获取 : manni.config.yaml,每个文件夹的图案覆盖.
在CI中运行GitHub Actions和其他 CI 配方,出站代码,以及PR说明.
定义进化计划( E)写出一个图案,用电线连接解析度,并在不突破构件的情况下进行版本.
参考文献每个 CLI 旗,动作输入,配置密钥, schema 分辨率优先链,以及输出格式.

捐款

欢迎捐款。 见 捐款额 用于dev设置,测试循环,以及如何添加对新输入格式的支持.

许可证

麻省理工学院

版本与发布记录

@hawkeyexl/manni 共发布 96 个版本,首次发布于 2026/09/06;过去 12 个月发布了 96 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.28.0latest2026/11/0215 天前
4.27.22026/10/2919 天前
4.27.12026/10/2919 天前
4.27.02026/10/2919 天前
4.26.22026/10/2820 天前
4.26.12026/10/2523 天前

其他发布通道:cite-follow-moved-sources → 2.9.0-cite-follow-moved-sources.2,cite-marker-ids → 2.10.0-cite-marker-ids.1。

关于 @hawkeyexl/manni 的常见问题

@hawkeyexl/manni 是什么?

用于检查文档的命令行 . manni meta 验证文档元数据(Markdown frontmatter and more)相对于为CI所建的JSON Schema的存在和格式. 原为多克米塔.

如何安装 @hawkeyexl/manni?

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

@hawkeyexl/manni 支持 TypeScript 吗?

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

@hawkeyexl/manni 支持 ESM 还是 CommonJS?

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

@hawkeyexl/manni 需要什么版本的 Node.js?

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

@hawkeyexl/manni 可以商用吗?

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

@hawkeyexl/manni 的下载量有多少?

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

@hawkeyexl/manni 还在维护吗?

最新版本 4.28.0 发布于 2026/11/02(15 天前);至今共发布 96 个版本,其中过去 12 个月发布了 96 个;首次发布于 2026/09/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。