# @headlamp-k8s/pluginctl 中文文档

规范地址：https://npmcn.com/package/%40headlamp-k8s/pluginctl/

版本：0\.1\.1
npm 元数据更新时间：2025-06-23T15:37:24.438Z
中文译文更新时间：2026-11-17T18:16:44.885Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40headlamp-k8s/pluginctl
原文对照：https://npmcn.com/package/%40headlamp-k8s/pluginctl/?lang=original

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

- 包体积（解压后）：77.1 kB，9 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：9 个
- 首次发布：2025-06-23T15:37:23.675Z
- 最新版本发布：2025-06-23T15:37:24.025Z
- 近 30 天下载量：82355（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

在 Headlamp 中管理插件的 CLI

## 安装

```sh
npm install @headlamp-k8s/pluginctl
```

也可以使用：`pnpm add @headlamp-k8s/pluginctl`、`yarn add @headlamp-k8s/pluginctl`、`bun add @headlamp-k8s/pluginctl`

## README

# @headlamp-k8s/ pluginctl (英语)

用于管理 Headlamp 插件的轻量级 CLI 工具.

## 目的

这个软件包为管理 Headlamp 插件提供了一个最小,重点突出的工具. 这是理想的:

-   从ArtifactHub 安装插件
-   管理插件配置
-   通过配置文件执行批量插件操作

## 使用量

```bash
pluginctl.js <command>

Commands:
  pluginctl.js extract <pluginPackages>     Copies folders of packages from plug
  <outputPlugins>                           inPackages/packageName/dist/main.js
                                            to
                                            outputPlugins/packageName/main.js.
  pluginctl.js package [pluginPath]         Creates a tarball of the plugin
  [outputDir]                               package in the format Headlamp
                                            expects.
  pluginctl.js install [URL]                Install plugin(s) from a
                                            configuration file or a plugin
                                            artifact Hub URL
  pluginctl.js update <pluginName>          Update a plugin to the latest
                                            version
  pluginctl.js uninstall <pluginName>       Uninstall a plugin
  pluginctl.js list                         List installed plugins

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]
```

## 配置文件格式

插件 。 雅姆尔:

```yaml
plugins:
  - name: my-plugin
    source: https://artifacthub.io/packages/headlamp/test-123/my-plugin
    version: 1.0.0
  - name: another-plugin
    source: https://artifacthub.io/packages/headlamp/test-123/another-plugin
    dependencies:
      - my-plugin
installOptions:
  parallel: true
  maxConcurrent: 3
```

## 可用类

该套件输出以下类别供方案使用:

-   `PluginManager`: 管理单个插件的核心类
-   `MultiPluginManager`: 处理多个插件及其依赖性的分类

示例用法:

```javascript
const { PluginManager, MultiPluginManager } = require('@headlamp-k8s/pluginctl');

// Create a plugin manager instance
const manager = new PluginManager();

// Create a multi-plugin manager for handling multiple plugins
const multiManager = new MultiPluginManager();
```

## 使用 npm 链接促进发展

要测试您的本地更改到 `pluginctl` 其他软件包中:

1.  创建全局并联 :

```bash
cd plugins/pluginctl
npm link
```

2.  在您想要使用本地版本的项目中 :

```bash
npm link @headlamp-k8s/pluginctl
```

这将创建一个与您本地开发版本的并联链接,而不是使用已发布的软件包 。 这对于:

-   发布前测试更改
-   调试问题
-   开发需要两个软件包改变的特性

取消链接 :

```bash
npm unlink @headlamp-k8s/pluginctl
```

## 与 @ kinvolk/ headlamp- plugin 的关系

`pluginctl` 是一个仅专注于插件管理操作的最小工具。 它提供下列核心功能:

-   安装插件
-   更新插件
-   删除插件
-   列出已安装的插件

相比之下, `@kinvolk/headlamp-plugin` 综合一揽子计划包括:

-   插件ctl 的所有插件管理特性
-   插件开发工具
-   建设和测试基础设施
-   代码质量工具

选择 `pluginctl` 如果您只需要插件管理特性,或者 `headlamp-plugin` 如果您需要完整的开发工具包.

## 常见问题

### @headlamp-k8s/pluginctl 是什么？

在 Headlamp 中管理插件的 CLI

### 如何安装 @headlamp-k8s/pluginctl？

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

### @headlamp-k8s/pluginctl 支持 TypeScript 吗？

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

### @headlamp-k8s/pluginctl 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @headlamp-k8s/pluginctl 可以商用吗？

@headlamp-k8s/pluginctl 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @headlamp-k8s/pluginctl 的下载量有多少？

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

### @headlamp-k8s/pluginctl 还在维护吗？

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

