@asyncapi/cli

中文文档
6.3.0发布于 2026/11/07Apache-2.0TypeScriptCommonJS构建来源已验证近 30 天下载 30万

所有 AsyncAPI 工具的 CLI

中文使用文档
文档目录10 节
  1. 目录
  2. 安装
  3. 使用量
  4. 建筑
  5. 调试( T)
  6. Github 动作
  7. 捐款
  8. 建立发展环境
  9. 命令结构和模式
  10. 贡献者

AsyncAPI CLI

CLI 可以使用您的 AsyncAPI 文件 。 目前正在发展之中,我们正在努力带来更多的特点.

GitHub license PR testing - if Node project npm

目录

安装

学习如何安装 AsyncAPI CMI , 方法是遵循其中的指令 安装指南。 。 。 .

使用量

这个 使用指南 提供不同方式使用CLI的信息.

建筑

这个 架构指南 提供架构信息。 捆绑者图书馆住在这里 packages/bundler。 。 。 .

调试( T)

这个 调试测试指南( t) 为调试CLI指令,API端点,以及服务提供分步指令,同时提供综合测试指南.

Github 动作

AsyncAPI 的 CLI 可用作 GitHub 动作. 您可以在 GitHub 动作指南。 。 。 .

捐款

读取 捐款 向导.

建立发展环境

读取 发展.md 用于开发设置的文件.

其他步骤:

  • 运行 npm run test 确保一切正常进行
  • 运行 npm run build 接下来 bin/run 尝试本地新 CLI

这个寄存器是npm-workspaces + Turbo monorepo. 根包子是: @asyncapi/cli (工作空间) 包含 "." 因此更改器仍然像今天一样. @asyncapi/optimizer 住在这里 packages/optimizer/ 财务报告和审定财务报表 @asyncapi/diff 住在这里 packages/diff/。两者单独发布至npm. 使用 npm run optimizer:build 编号 : npm run optimizer:test 财务报告和审定财务报表 npm run diff:build 编号 : npm run diff:test 来研究那些包裹 见其规格: 优化器, (中文(简体) ), 微调。 。 。 .

为CLI开发的UX应当遵守 命令行界面准则

命令结构和模式

我们跟着 verb + noun 财务报告和审定财务报表 namespace + noun + [verb] 用于发布命令和参数的模式。 举个例子 asyncapi validate <spec-file-path> 财务报告和审定财务报表 asyncapi config context add <context-name> <spec-file-path>。 。 。 .

贡献者

感谢这些优秀的人emoji 密钥:

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
维沙尔·夏尔马

💻

本项目遵循 全部贡献者 规格。 任何捐款都欢迎!

版本与发布记录

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

版本发布日期距今
6.3.0latest2026/11/07今天
6.2.32026/11/025 天前
6.2.22026/10/2712 天前
6.2.12026/10/1226 天前
6.2.02026/09/231 个月前
6.1.02026/09/151 个月前

关于 @asyncapi/cli 的常见问题

@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 和提交记录判断。