# @asyncapi/cli 中文文档 规范地址：https://npmcn.com/package/%40asyncapi/cli/ 版本：6\.3\.0 npm 元数据更新时间：2026-11-07T02:23:23.669Z 中文译文更新时间：2026-11-07T01:37:58.046Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40asyncapi/cli 原文对照：https://npmcn.com/package/%40asyncapi/cli/?lang=original 项目主页：https://github.com/asyncapi/cli 源码仓库：https://github.com/asyncapi/cli ## 关键信息（来自 npm 元数据） - 包体积（解压后）：1.4 MB，290 个文件 - 模块格式：CommonJS - TypeScript 类型：包内自带 - Node.js 要求：\>=24\.11\.0 - 运行依赖：40 个 - 首次发布：2021-06-18T12:06:58.259Z - 最新版本发布：2026-11-07T02:23:23.329Z - 近 30 天下载量：300001（2026-10-07 至 2026-11-05，npm 官方下载统计） - 已发布版本数：451（近 12 个月 18 个） ## 中文简介 所有 AsyncAPI 工具的 CLI ## 安装 ```sh npm install @asyncapi/cli ``` 也可以使用：`pnpm add @asyncapi/cli`、`yarn add @asyncapi/cli`、`bun add @asyncapi/cli` ## README [![AsyncAPI CLI](https://npmcn.com/package/%40asyncapi/cli/assets/logo.png)](https://www.asyncapi.com/tools/cli) CLI 可以使用您的 AsyncAPI 文件 。 目前正在发展之中,我们正在努力带来更多的特点. [![GitHub license](https://img.shields.io/github/license/asyncapi/cli)](https://github.com/asyncapi/cli/blob/master/LICENSE) [![PR testing - if Node project](https://github.com/asyncapi/cli/actions/workflows/if-nodejs-pr-testing.yml/badge.svg)](https://github.com/asyncapi/cli/actions/workflows/if-nodejs-pr-testing.yml) [![npm](https://img.shields.io/npm/dw/@asyncapi/cli)](https://www.npmjs.com/package/@asyncapi/cli) ## 目录 - [安装](https://npmcn.com/package/%40asyncapi/cli/#readme-installation) - [使用量](https://npmcn.com/package/%40asyncapi/cli/#readme-usage) - [建筑](https://npmcn.com/package/%40asyncapi/cli/#readme-architecture) - [调试( T)](https://npmcn.com/package/%40asyncapi/cli/#readme-debugging--testing) - [Github 动作](https://npmcn.com/package/%40asyncapi/cli/#readme-github-action) - [捐款](https://npmcn.com/package/%40asyncapi/cli/#readme-contributing) - [建立发展环境](https://npmcn.com/package/%40asyncapi/cli/#readme-set-up-development-environment) - [命令结构和模式](https://npmcn.com/package/%40asyncapi/cli/#readme-command-structure-and-patterns) - [贡献者](https://npmcn.com/package/%40asyncapi/cli/#readme-contributors) ## 安装 学习如何安装 AsyncAPI CMI , 方法是遵循其中的指令 [安装指南](https://npmcn.com/docs/installation.md)。 。 。 . ## 使用量 这个 [使用指南](https://npmcn.com/docs/usage.md) 提供不同方式使用CLI的信息. ## 建筑 这个 [架构指南](https://npmcn.com/docs/architecture.md) 提供架构信息。 捆绑者图书馆住在这里 [`packages/bundler`](https://github.com/asyncapi/cli/tree/master/packages/bundler)。 。 。 . ## 调试( T) 这个 [调试测试指南( t)](https://npmcn.com/docs/debugging-testing.md) 为调试CLI指令,API端点,以及服务提供分步指令,同时提供综合测试指南. ## Github 动作 AsyncAPI 的 CLI 可用作 GitHub 动作. 您可以在 [GitHub 动作指南](https://www.asyncapi.com/docs/tools/cli/github-action)。 。 。 . ## 捐款 读取 [捐款](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md) 向导. ### 建立发展环境 读取 [发展.md](https://npmcn.com/DEVELOPMENT.md) 用于开发设置的文件. 其他步骤: - 运行 `npm run test` 确保一切正常进行 - 运行 `npm run build` 接下来 `bin/run` 尝试本地新 CLI > 这个寄存器是npm-workspaces + Turbo monorepo. 根包子是: `@asyncapi/cli` (工作空间) 包含 `"."` 因此更改器仍然像今天一样. `@asyncapi/optimizer` 住在这里 [`packages/optimizer/`](https://npmcn.com/packages/optimizer) 财务报告和审定财务报表 `@asyncapi/diff` 住在这里 [`packages/diff/`](https://npmcn.com/packages/diff)。两者单独发布至npm. 使用 `npm run optimizer:build` 编号 : `npm run optimizer:test` 财务报告和审定财务报表 `npm run diff:build` 编号 : `npm run diff:test` 来研究那些包裹 见其规格: [优化器](https://npmcn.com/docs/optimizer/spec.md), (中文(简体) ), [微调](https://npmcn.com/docs/diff/spec.md)。 。 。 . 为CLI开发的UX应当遵守 [命令行界面准则](https://clig.dev/) ### 命令结构和模式 我们跟着 `verb + noun` 财务报告和审定财务报表 `namespace + noun + [verb]` 用于发布命令和参数的模式。 举个例子 `asyncapi validate ` 财务报告和审定财务报表 `asyncapi config context add `。 。 。 . ## 贡献者 感谢这些优秀的人[emoji 密钥](https://allcontributors.org/docs/en/emoji-key):
Jorge Aguiar Martín
豪尔赫·阿吉亚尔·马丁
💻 🤔 ⚠️ 📖		Lukasz Gornicki
卢卡斯·戈尔尼茨基
🤔 💻 👀 🚧		souvik
苏维克语
💻 🤔 ⚠️ 👀 🚧 📖		David Boyne
大卫·博因
💻 🤔 🚧		Fran Méndez
弗朗·门德斯
💻 🤔 👀		Maciej Urbańczyk
马西杰·乌尔班奇克
👀 🚧 🤔		Aayush Kumar Sahu
阿尤什·库马尔·萨胡
💻 ⚠️
Mihir Kulkarni
米希尔·库尔卡尔尼
💻		Abir
阿比尔
⚠️ 💻		Peter Ramos
彼得·拉莫斯
💻		Samriddhi
萨姆里德迪
⚠️		Pranay Kharabe
普拉奈·哈拉贝
💻		Damilola Oladele
达米洛拉·奥拉德勒
📖		Abhay Garg
阿比・加格
💻 ⚠️
Sambhav Gupta
萨姆哈夫·古普塔
💻 ⚠️		Hippolyte Vergnol
Hippolyte Vergnol (英语)
💻 🚇		Jente Vets
简特·韦茨
💻		Rishi
丽希
💻		Ashish Padhy
阿诗·帕迪
💻		Meet Agrawal
见见阿格拉瓦尔
🚇		Chinmay Shewale
钦迈·谢瓦尔
💻 ⚠️
Mahfuza Humayra Mohona
马赫富扎·胡迈拉·莫霍纳
📖		Heiko Henning
兴宁平子
💻		Zack_Aayush
扎克-阿约什
💻		Ayush Nautiyal
阿尤什·瑙蒂亚勒
💻		AnishKacham
阿尼什卡萨姆
💻		Viacheslav Turovskyi
维亚切斯拉夫·图罗夫斯基伊
💻		Amanpreet Singh Bedi
阿芒普雷特·辛格·贝迪
💻
Debajyoti Halder
德巴吉奥蒂·哈尔德
💻		Savio Dias
萨维奥·迪亚斯
💻		Jonas Lagoni
乔纳斯·拉戈尼
💻 🤔 👀 ⚠️		Khuda Dad Nomani
胡达爸爸诺马尼
💻 📖		Sergio Moya
塞尔吉奥·莫亚
💻		Vishal Sharma
维沙尔·夏尔马
💻
本项目遵循 [全部贡献者](https://github.com/all-contributors/all-contributors) 规格。 任何捐款都欢迎! ## 常见问题 ### @asyncapi/cli 是什么？ 所有 AsyncAPI 工具的 CLI ### 如何安装 @asyncapi/cli？ 在项目目录运行 npm install @asyncapi/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 asyncapi，可以用 npx asyncapi 直接运行。 ### @asyncapi/cli 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @asyncapi/cli 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @asyncapi/cli 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=24\.11\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @asyncapi/cli 可以商用吗？ @asyncapi/cli 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @asyncapi/cli 的下载量有多少？ 根据 npm 官方下载统计，@asyncapi/cli 在 2026/10/07 – 2026/11/05 这 30 天内被下载 300,001 次，日均约 10,000 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @asyncapi/cli 还在维护吗？ 最新版本 6\.3\.0 发布于 2026/11/07（今天）；至今共发布 451 个版本，其中过去 12 个月发布了 18 个；首次发布于 2021/06/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。