StartPlugin

A plugin for Magnolia CLI to start up Magnolia and display the logs

Installation

Using add-plugin

1. Run the following command in the project's root directory:

   npm run mgnl -- add-plugin @magnolia/cli-start-plugin

   The command will install the plugin, and automatically register the plugin in mgnl.config.js file:

   import StartPlugin from "@magnolia/cli-start-plugin";
   
   export default {
     plugins: [
       new StartPlugin()
     ]
   };

2. To confirm that the plugin has been successfully installed, run:

   npm run mgnl -- start --help

Manually

1. Run the following command in the project's root directory:

   npm install @magnolia/cli-start-plugin

2. Manually add StartPlugin to mgnl.config.js file:

   import StartPlugin from "@magnolia/cli-start-plugin";
   
   export default {
     plugins: [
       new StartPlugin()
     ]
   };

3. To confirm that the plugin has been successfully installed, run:

   npm run mgnl -- start --help

Usage

Options

| Short | Long | Description | |---------------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------| | -t [path] | --tomcat [path] | set the path to the "apache-tomcat" directory or the directory containing it; defaults to the current working directory | | -lmp [path] | --light-modules-path [path] | set the path to the light modules directory; defaults to mgnl.config.js or "magnolia.resources.dir" in "magnolia.properties" | | -v | --version | output the version number | | -h | --help | display help for command |

Examples

Start Magnolia

npm run mgnl -- start

This command initiates the Magnolia CMS if an "apache-tomcat" is found in the current directory

Start Magnolia with "apache-tomcat" in child directory

npm run mgnl -- start --tomcat "./magnolia/apache-tomcat"

This command starts the "apache-tomcat" located within the "./magnolia/apache-tomcat" subdirectory

Start Magnolia with "apache-tomcat" and "light-modules" in child directory

npm run mgnl -- start --tomcat "./magnolia/apache-tomcat" --light-modules-path "./magnolia/light-modules"

This command starts the "apache-tomcat" located in "./magnolia/apache-tomcat" and includes light modules from "./magnolia/light-modules"

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