The core CLI package for running wlpn plugin commands.

Usage no npm install needed!

<script type="module">
  import wlpn from 'https://cdn.skypack.dev/wlpn';



WebSphere Liberty Profile for Node.js

The core CLI package for running wlpn plugin commands.


The wlpn package provides a command-line tool for performing commands on the WLPN runtime for both server operations and collective operations. Additionally, the wlpn module supports a plugin interface that allows arbitrary extension of its capabilities, as well as mounting those extensions (and help dialog) onto the CLI commands list.



To get the wlpn version, run wlpn -v or wlpn --version. This will return the wlpn version as well as the API Connect release it's associated with.

To get the extended version list of wlpn and any installed plugins, run wlpn --ext-version. This may be useful if required to reproduce and debug issues with certain plugin versions, or interoperation between plugins.

$ wlpn --ext-version
wlpn: v2.2.5 (API Connect: v5.0.6.2)
 plugins 3.3.7
 wlpn-cli-collective 2.4.0
 wlpn-cli-server 2.7.8

Note: There is no single-letter flag for the extended version printout.


To print out the help for the top-level wlpn module, run wlpn -h or wlpn --help.

To print out help for a plugin, run wlpn <plugin> -h, where <plugin> is the command name of the plugin. For example, if the wlpn-magic-log-router (not a real plugin) was installed, but the command name for using it was magicRouter, then you would run wlpn magicRouter -h or wlpn magicRouter:help



To list the plugins available on wlpn, run wlpn plugins:list. Running wlpn plugins without the specified sub-command will also list your plugins. Example:

$ wlpn plugins:list
plugins 3.3.7
wlpn-cli-collective 2.4.0
wlpn-cli-server 2.7.8


To install a plugin, run wlpn plugins:install <target> where <target> can be:

  • A gzipped tarball (.tgz or .tar.gz)
  • A URL to an npm package
  • The name of a package available on the currently configured npm repository (by default, this will be http://registry.npmjs.org)

The plugin must be a valid plugin, which means it must have the apic-toolkit-plugin phrase in the package.json under keywords, and must provide one or more "components" or "topics". The installation process will attempt to validate the plugin.


To uninstall a plugin, run wlpn plugins:uninstall <name>, where <name> is the name of the plugin.


As a default, the wlpn-cli-server plugin is included when installing the wlpn module. It provides the facilities required to unpack Node.js applications you intend to deploy, as well as runtime management functions like run, start, stop and status.


The wlpn module also includes the wlpn-cli-collective plugin, which handles Liberty Collective operations for host machines and application instances.