@headlamp-k8s/pluginctl

中文文档
0.1.1发布于 2025/06/23CommonJS近 30 天下载 8.2万

CLI for managing plugins in Headlamp

原始使用文档
文档目录6 节
  1. Purpose
  2. Usage
  3. Configuration File Format
  4. Available Classes
  5. Using npm link for Development
  6. Relationship with @kinvolk/headlamp-plugin

@headlamp-k8s/pluginctl

A lightweight CLI tool for managing Headlamp plugins.

Purpose

This package provides a minimal, focused tool for managing Headlamp plugins. It's ideal for:

  • Installing plugins from ArtifactHub
  • Managing plugin configurations
  • Performing bulk plugin operations via configuration files

Usage

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]

Configuration File Format

plugins.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

Available Classes

The package exports the following classes for programmatic use:

  • PluginManager: Core class for managing individual plugins
  • MultiPluginManager: Class for handling multiple plugins and their dependencies

Example usage:

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();

To test your local changes to pluginctl in other packages:

  1. Create a global symlink:
cd plugins/pluginctl
npm link
  1. In the project where you want to use the local version:
npm link @headlamp-k8s/pluginctl

This will create a symlink to your local development version instead of using the published package. This is useful for:

  • Testing changes before publishing
  • Debugging issues
  • Developing features that require changes in both packages

To unlink:

npm unlink @headlamp-k8s/pluginctl

Relationship with @kinvolk/headlamp-plugin

pluginctl is a minimal tool focused solely on plugin management operations. It provides the core functionality for:

  • Installing plugins
  • Updating plugins
  • Removing plugins
  • Listing installed plugins

In contrast, @kinvolk/headlamp-plugin is a comprehensive package that includes:

  • All plugin management features from pluginctl
  • Plugin development tools
  • Build and testing infrastructure
  • Code quality tools

Choose pluginctl if you only need plugin management features, or headlamp-plugin if you need the full development toolkit.

版本与发布记录

@headlamp-k8s/pluginctl 共发布 1 个版本,首次发布于 2025/06/23;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.1latest2025/06/231.4 年前

关于 @headlamp-k8s/pluginctl 的常见问题

@headlamp-k8s/pluginctl 是什么?

CLI for managing plugins in Headlamp

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