进阶 oclif.io 2026-10-18 02:37:03 · 19 阅读
第40章 Oclif 插件开发指南
插件
插件是提供实验性功能、允许用户扩展你的 CLI、将 CLI 拆分为模块化组件或在多个 CLI 之间共享功能的好方法。
插件可以像 CLI 一样拥有命令或 hooks。若要添加一个插件,例如 not-found 插件,首先通过 yarn add @oclif/plugin-not-found 将其添加到你的 CLI 中,然后将以下内容添加到你的 package.json:
{
"name": "mycli",
"version": "0.0.0",
// ...
"dependencies": {
"@oclif/core": "^3",
"@oclif/plugin-help": "^6",
"@oclif/plugin-not-found": "^3",
}
"oclif": {
"plugins": [
"@oclif/plugin-help",
"@oclif/plugin-not-found"
]
}
}
也可以使用 minimatch 模式来指定插件: {
"name": "mycli",
"version": "0.0.0",
// ...
"dependencies": {
"@oclif/core": "^3",
"@oclif/plugin-help": "^6",
"@oclif/plugin-not-found": "^3",
}
"oclif": {
"plugins": [
"@oclif/plugin-*",
]
}
}
如果你希望用户能够向你的 CLI 安装自己的插件,请使用 plugins 插件。 常用插件 @oclif/plugin-not-found - 如果找不到命令,显示友好的“是否想说”消息。 @oclif/plugin-plugins - 允许用户添加插件来扩展你的 CLI。 @oclif/plugin-update - 为 CLI 添加自动更新支持。 @oclif/plugin-help - oclif 的帮助插件。 @oclif/plugin-warn-if-update-available - 如果用户运行的是旧版 CLI,显示警告消息。 @oclif/plugin-which - 显示命令来自哪个插件。 @oclif/plugin-commands - 添加 commands 命令以列出所有命令。 @oclif/plugin-autocomplete - 添加 bash/zsh 自动补全功能。 @oclif/plugin-search - 为你的 CLI 添加搜索命令。 @oclif/plugin-version - 为你的 CLI 添加版本命令。 构建你自己的插件 编写插件的代码基本上与在 CLI 内部编写代码相同。它们可以导出 3 种不同的类型:commands、hooks 和其他插件。 运行 npx oclif generate mynewplugin 在新目录中创建插件。这将附带一个示例命令,名为 hello 和 hello world。
"name": "mycli",
"version": "0.0.0",
// ...
"dependencies": {
"@oclif/core": "^3",
"@oclif/plugin-help": "^6",
"@oclif/plugin-not-found": "^3",
}
"oclif": {
"plugins": [
"@oclif/plugin-help",
"@oclif/plugin-not-found"
]
}
}
也可以使用 minimatch 模式来指定插件: {
"name": "mycli",
"version": "0.0.0",
// ...
"dependencies": {
"@oclif/core": "^3",
"@oclif/plugin-help": "^6",
"@oclif/plugin-not-found": "^3",
}
"oclif": {
"plugins": [
"@oclif/plugin-*",
]
}
}
如果你希望用户能够向你的 CLI 安装自己的插件,请使用 plugins 插件。 常用插件 @oclif/plugin-not-found - 如果找不到命令,显示友好的“是否想说”消息。 @oclif/plugin-plugins - 允许用户添加插件来扩展你的 CLI。 @oclif/plugin-update - 为 CLI 添加自动更新支持。 @oclif/plugin-help - oclif 的帮助插件。 @oclif/plugin-warn-if-update-available - 如果用户运行的是旧版 CLI,显示警告消息。 @oclif/plugin-which - 显示命令来自哪个插件。 @oclif/plugin-commands - 添加 commands 命令以列出所有命令。 @oclif/plugin-autocomplete - 添加 bash/zsh 自动补全功能。 @oclif/plugin-search - 为你的 CLI 添加搜索命令。 @oclif/plugin-version - 为你的 CLI 添加版本命令。 构建你自己的插件 编写插件的代码基本上与在 CLI 内部编写代码相同。它们可以导出 3 种不同的类型:commands、hooks 和其他插件。 运行 npx oclif generate mynewplugin 在新目录中创建插件。这将附带一个示例命令,名为 hello 和 hello world。