README
PKP Plugin Registry CLI
A set of tools by the Public Knowledge Project to help with publishing new plugins for OJS and OMP
Get Started
Prerequisites
- Download and install Node (>v12)
- To Check if it's already installed, run
node -v
on the terminal
Install
npm install -g pkp-plugin-cli
To update the tool, run npm update -g pkp-plugin-cli
Publishing a package
Install np package globally:
npm install --global np
Run
np
on the command line and follow the wizard.
Commands
pkp-plugin validate-all-releases --input ./path/to/plugins.xml
(used internally by CI) extracts all the releases from plugins.xml
and validate their MD5 hashes
pkp-plugin validate-new-release
(used internally by CI) validates the new releases added to a plugin.xml file (used internally by the CI tool)
pkp-plugin version
Outputs the version of the installed plugin
pkp-plugin help
Prints help information about the tool