Generate Plugin

A plugin for Magnolia CLI to generate a basic structure for a new CLI plugin

Installation

Within the Magnolia CLI plugin system, this plugin is pre-installed and ready to be used.

Usage

Options

| Short | Long | Description | |-------------|------------------|-----------------------------------------| | -n <name> | --name <name> | set the name of the plugin | | -c <name> | --class <name> | set the name of the plugin's main class | | -v | --version | output the version number | | -h | --help | display help for command |

Examples

Create a new plugin

mkdir testPluginFolder
cd testPluginFolder
npx @magnolia/cli generate-plugin --name "cli-test-plugin" --class-name "TestPlugin"

Upon executing the command, the following structure will be created:

testPluginFolder/
└── .npmignore
└── cli-test-plugin.ts
└── index.ts
└── package.json
└── package-lock.json
└── README.md
└── tsconfig.json
└── node_modules/
└── tests/

Plugin Documentation

For detailed documentation of the plugin, please refer to Plugin Documentation

Magnolia CMS

This plugin is created to work with Magnolia CMS. For more information, please refer to Magnolia CMS Documentation