Magnolia CLI is an npm package providing a command line interface (CLI) tool to set up and facilitate light development with Magnolia. This page describes how to configure and use its commands in the version 3 branch. If you are using a version 2 of Magnolia CLI, please see the page called Magnolia CLI v2 instead. To install Magnolia CLI, see the main Magnolia CLI page.
The commands of the Magnolia CLI package facilitate the creation of a light module skeleton: the folders and files that form a typical Magnolia light module. We assume that you are already familiar with some Magnolia basics of creating light modules, templates and dialogs.
Configuration
Magnolia CLI is configured in these files/folders:
mgnl‑cli‑prototypes/– A folder which contains the prototypes for template and dialog definitions and the README file.mgnl‑cli.json– The configuration file defining the folders of the light module skeleton among other things.
Do not modify the package.json of your global installation, consider creating one local package.json for each project instead.
When you execute a CLI command, the system searches for the JSON configuration.
Global and local configurations
You can use the placeholder variables such as name and lightDevModuleFolder in prototypes files.
Global
The global configuration is created during the global installation of the Magnolia CLI package. On Linux or OS-X the global configuration files are typically located in the /usr/local/lib/node_modules/@magnolia/cli folder.
The CLI commands use the global configuration if no local configuration is found in the current directory or in its parent folders.
Local
For different projects you can create various local configurations with the customize-local-config command. This command creates local configuration files in the /wherever/you-have/executed/the-customize-local-config-command folder.
The local configuration is created as a copy of the current configuration (used during execution of the customize-local-config command), which you can edit to define project specific prototypes or dependencies.
When executing commands from within the local configuration folders or subfolders, the local configuration is used.
You cannot mix global and local configurations. When adding a local configuration it must be complete: it must contain the mgnl-cli.json file and the complete mgnl-cli-prototypes folder.
If Magnolia CLI finds the mgnl-cli.json file in the current or a parent directory, it expects to find the complete mgnl-cli-prototypes as well.
mgnl-cli.json
This JSON file contains basic configuration used when running Magnolia CLI commands. Here is a list of some of the properties in mgnl-cli.json:
| Property | Meaning |
|---|---|
downloadFolder | The directory where Magnolia CLI stores downloaded artifacts. We recommend you do not edit this property. |
downloadUrl | The base URL of a Nexus repository used to download software artifacts such as a pre-configured Apache Tomcat servlet container and Magnolia webapps. We recommend you do not edit this property. |
downloadJars | A map of artifacts to be added to the Add artifacts to customize your webapps. |
tomcatFolder | The name of the folder where the Magnolia bundled with Apache Tomcat is installed during the execution of the jumpstart command. |
| If set, these properties override the same properties in the magnolia.properties file by overwriting them. Note that you cannot set the These properties are used to update the |
availableWebapps | A list of possible webapps to choose from when executing jumpstart. You can define additional webapp artifacts, if they are available in the Nexus repository specified by the |
All the properties above are used when executing the jumpstart command.
Prototypes
When you execute the create-block, create-component, create-light-module, create-page, create-virtual-uri commands, you create new files from the prototype files. These prototype files are located in the mgnl-cli-prototypes folder. For more information about the prototypes see the subpage called Prototypes in CLI v3.
Commands
add-availability
This command makes a component available to a page by:
- Adding or updating the page template definition to enable the component for an area.
- Adding the
cms:areadirective to the template script (if it is not already there).
The command only succeeds if the current directory (or the directory defined by the -p <path> parameter) is a light module with a minimal folder structure and if the page specified by the second argument exists.
Usage
mgnl add-availability <[module-id:]path-to-component> <path-to-page[@area]> [options]
Parameters
| Parameter | Description |
|---|---|
<[module‑id:]path‑to‑component> | required The component you want to make available. Must at least contain the path to a component. Can optionally start with the module identifier Magnolia CLI does not check the existence of the specified component. |
<path‑to‑page[@area]> | required The page you want to make the component available to. The parameter starts with the path to the page template within the templates directory and it must end with an area name If you do not specify an area, the command defaults to |
Options
| Short form | Long form | Description |
|---|---|---|
-p <path> | --path <path> | optional The path to the light module that contains the page template. If the parameter is omitted, the command must be run in an existing light module folder. |
-g | Add this parameter to autogenerate the component instead of providing plain availability. |
Examples
This example makes a component from the mtk module available to the page named my-page in the area named main:
mgnl add-availability mtk:components/textImage pages/my-page@main
my-component available to the page my-page. Both the component and the page are part of the light module located at /Users/jdoe/dev/mgnl/light-modules/my-module/:mgnl add-availability components/my-component pages/my-page@main -p /Users/jdoe/dev/mgnl/light-modules/my-module/
create-app
This command creates a content type and an app based on it (depending on the CLI prototype variant applied). The command creates the following two YAML files:
- A content type definition file in the
contentTypesfolder of the light module. - An app descriptor in the
appsfolder of the light module.
The command succeeds only if the current directory (or the directory defined by the -p option) is a light module with at least a minimal folder structure.
The files which are created while executing this command are based on the files in the prototypes folder of your configuration. The files contain some standard code and example properties.
If you want to create just a content type, use the create-content-type command.
Usage
mgnl create-app <name> [options]
Parameters
| Parameter | Description |
|---|---|
<name> | required The name of the new app. The name cannot contain spaces. |
Options
| Short form | Long form | Description |
|---|---|---|
-p <path> | --path <path> | optional The path to the light module where you want to create the app. If you do not specify a path, the command must be run within an existing light module folder. |
| --prototype <name> | optional The name of the prototype variant to create the app. |
Example
mgnl create-app my-app -p /Users/johndoe/dev/mgnl/light-modules/my-module/
To start entering content in a newly created app, you first have to login again in the Admincentral.
In a production environment, you also need to set up security for the content types and apps you created. For more details on this, see Setting up security.
create-block
This command creates a new block definition based on FieldSetBlockDefinition with (depending on the CLI prototype variant applied):
- A block definition YAML file.
- A template definition YAML file.
- A freemarker template script.
The command succeeds only if the current directory (or the directory defined by the optional -p <path> parameter) is a light module with a minimal folder structure. The files which are created when executing this command are built from the files in the prototypes folder of your configuration. The files contain some standard code with some commonly used properties. This is generally a good starting point to build a block.
Usage
mgnl create-block <blockName> [options]
Parameters
| Parameter | Description |
|---|---|
<blockName> | required The name of the new block definition. The block name cannot contain spaces. |
Options
| Short form | Long form | Description |
|---|---|---|
-p <path> | --path <path> | optional The path to the light module to add the new block to. If you do not specify a path, you must run the command from an existing light module folder. |
| --prototype <name> | optional The name of the prototype variant to create the block. The following pre-configured prototype variants are available: |
Example
mgnl create-block my-block
If you do not use the -p <path> option, you must run the command from an existing light module folder.
create-component
This command creates a new component template with (depending on the CLI prototype variant applied):
- A template definition YAML file.
- A freemarker template script.
- A YAML dialog definition file.
Optionally, the component can be made available to a page using the -a option (internally calling the add-availability command).
The command succeeds only if the current directory (or the directory defined by the -p option) is a light module with a minimal folder structure.
The files which are created while executing this command are based on the files in the prototypes folder of your configuration. The files contain some standard code with some commonly used properties. This is generally a good starting point to build a component template.
Usage
mgnl create-component <name> [options]
Parameters
| Parameter | Description |
|---|---|
<name> | required The name of the new component template. The name cannot contain spaces. |
Options
| Short form | Long form | Description |
|---|---|---|
-p <path> | --path <path> | optional The path to the light module you want to add the component template to. If you do not specify a path, the command must be run within an existing light module folder. |
-a <path‑to‑page[@area]> |
| optional The page you want to make the component available to. When you specify this option, The parameter must start with the path to the page template within the templates directory and it must end with an area name. If the area does not exist yet, the command adds an area to both the template script and the template definition. If you do not specify an area, the command defaults to |
-g <path‑to‑page[@area]> |
| optional Add this parameter to autogenerate the component instead of providing plain availability. As for the |
| --prototype <name> | optional The name of the prototype variant to create the component. The following pre-configured prototype variants are available: |
Example
mgnl create-component my-component -a pages/my-page@footer -p /Users/johndoe/dev/mgnl/light-modules/my-module/
create-content-type
This command creates a content type (depending on the CLI prototype variant applied). The content type is created as a YAML content type definition file in the contentTypes folder of the light module.
The command succeeds only if the current directory (or the directory defined by the -p option) is a light module with at least a minimal folder structure.
The file created while executing this command is based on a file in the prototypes folder of your configuration. The file contains some standard code and example properties.
Usage
mgnl create-content-type <name> [options]
Parameters
| Parameter | Description |
|---|---|
<name> | required The name of the new content type. The name cannot contain spaces. |
Options
| Short form | Long form | Description |
|---|---|---|
-a | optional Creates also a new app that references the content type. With the
| |
-p <path> | --path <path> | optional The path to the light module where you want to create the content type. If you do not specify a path, the command must be run within an existing light module folder. |
| --prototype <name> | optional The name of the prototype variant to create the content type. |
Example
mgnl create-content-type foo -a -p /Users/johndoe/dev/mgnl/light-modules/my-module/
In a production environment, you also need to set up security for the content types and apps you created. For more details, see Setting up security.
create-light-module
This command creates a new light module in the form of a set of empty light module folders and the following two files:
README.md, in the root folder of the module.<moduleName>-messages_en.properties, in thei18nfolder this command creates.
The name of the light module should be provided as a parameter when calling the command. The light module is created in the current directory or in the directory specified with the optional -p <path> parameter.
Usage
mgnl create-light-module [<moduleName>] [options]
Parameters
| Parameter | Description |
|---|---|
<moduleName> | optional (but recommended) The name of the new light module. Avoid spaces and special characters since this name is used as folder name. If you do not specify a |
Options
| Short form | Long form | Description |
|---|---|---|
-p <path> | --path <path> | optional The path of the parent directory for the new light module. If omitted, the new light module is created within the current folder. |
| --prototype <name> | optional The name of the prototype variant to create the light module. The following pre-configured prototype variants are available: |
Examples
mgnl create-light-module my-module
mgnl create-light-module my-module -p ../../light-modules/
create-page
This command creates a new page template with (depending on the CLI prototype variant applied):
- A template definition YAML file.
- A freemarker template script.
- A YAML dialog definition file.
The command succeeds only if the current directory (or the directory defined by the optional -p <path> parameter) is a light module with a minimal folder structure. The files which are created when executing this command are built from the files in the prototypes folder of your configuration. The files contain some standard code with some commonly used properties. This is generally a good starting point to build a page template.
Usage
mgnl create-page <templateName> [options]
Parameters
| Parameter | Description |
|---|---|
<templateName> | required The name of the new page template. The template name cannot contain spaces. |
Options
| Short form | Long form | Description |
|---|---|---|
-p <path> | --path <path> | optional The path to the light module to add the new template to. If the parameter is omitted, the command must be run within an existing light module folder. |
| --prototype <name> | optional The name of the prototype variant to create the page. The following pre-configured prototype variants are available: |
Example
mgnl create-page my-page
If you do not use the -p <path> parameter, you must run the command from an existing light module folder.
create-virtual-uri
The command creates a virtual URI mapping configuration file (a YAML definition file) in the light module. The command succeeds only if the current directory (or the directory defined by the -p option) is a light module with a minimal folder structure. The file with a mapping is created in the virtualUriMappings folder. The folder is created by the command if it does not exist yet. The file created while executing this command is based on the files in the prototypes folder of your configuration.
Usage
mgnl create-virtual-uri <virtualUriName> [options]
Parameters
| Parameter | Description |
|---|---|
<virtualUriName> | required The name of the new URI configuration. |
Options
| Short version | Long version | Description |
|---|---|---|
| --path <path> | optional The path to the light module. If no path is provided, then the current folder is assumed to be a light module and the virtual URI mapping is created there. |
| --fromUri <uri> | optional The pattern to be matched in the requested URI. Enclose the
|
| --toUri <prefix:uri> | optional A concrete URI that the request is mapped to. Enclose the
The following action prefixes are supported: |
| --prototype <name> | optional The name of the prototype variant to create the mapping. The following prototypes are available: The The No class is specified in the |
customize-local-config
Run this command to create a local configuration. It installs the files for the local configuration within the current directory, or within the directory defined by the optional -p <path> parameter.
Usage
mgnl customize-local-config [options]
Options
| Short form | Long form | Description |
|---|---|---|
-p <path> | --path <path> | optional The path into which the |
Example
mgnl customize-local-config -p ~/dev/mgnl/light-modules/
install
Downloads and installs one or more light modules from npm to the light module directory.
Usage
mgnl install <light-module-name> [options]
Parameters
| Parameter | Description |
|---|---|
<light-module-name> | required At least one name of a light module to be downloaded from npm. If you are installing more than one module from the repository, separate the module names with a space. |
Options
| Short form | Long form | Description |
|---|---|---|
-p <path> |
| optional The path to the light-modules folder. If you do not specify a path, Magnolia searches for the nearest |
Example
mgnl install google-maps-magnolia mgnl-bobby -p /Users/johndoe/dev/mgnl/light-modules/other-users-modules/
jumpstart
This command downloads, unpacks and pre-configures a Magnolia Tomcat server together with a specific webapp . It creates folders for the Tomcat server and for the light modules according to the configuration.
When you run this command, you are prompted to choose which Magnolia webapp you want to install:
? What Magnolia would you like to install? 1) magnolia-empty-webapp 2) magnolia-community-webapp 3) magnolia-community-demo-webapp 4) magnolia-dx-core-webapp 5) magnolia-dx-core-demo-webapp Answer:
If you do not specify a webapp, the command downloads the latest released version of the magnolia-community-webapp.
If you choose a licensed webapp, you are prompted to enter access credentials to the Magnolia Nexus repository.
The jumpstart command installs the webapp within the current directory.
Usage
mgnl jumpstart [options]
Options
| Short form | Long form | Description |
|---|---|---|
-p <path> |
| optional The The path to the light modules root folder is set by the If no path is provided:
|
-m <version> |
| optional Use to choose a specific version of the Magnolia webapp. If not provided, the latest stable version of the specified webapp is downloaded. |
-i <name> |
| optional If provided, a sample light module under the light modules root folder with the given name is created. |
-s | --snapshot | optional Downloads the latest snapshot development version of the specified webapp. |
-w <webapp> | --webapp <webapp> | optional Use to directly specify which Magnolia webapp you want to install. The webapps available by default are:
You can change which webapps are listed by editing your If you do not specify a webapp using the |
Example
mgnl jumpstart -w magnolia-empty-webapp -m 6.1
When running the jumpstart command, make sure that the magnolia.war and tomcat.zip files do not already exist in the directory in which you are running the command. The presence of these files prevents the command from downloading new versions and the system simply installs from the existing files again.
See NPMCLI-100 - Getting issue details... STATUS
help
Run the help command to list all the available commands of the Magnolia CLI package.
Usage
mgnl help [options]
Options
| Option | Description |
|---|---|
<command> | optional Shows basic help for the Magnolia CLI command specified as the option. Without the option, a list of available CLI commands are displayed (same as entering |
tab-completion
Run the command to install or uninstall autocompletion for Magnolia CLI commands.
Usage
mgnl tab-completion <command>
Parameters
| Parameter | Description |
|---|---|
install | Installs the required files for autocompletion. |
uninstall | Removes the files which were previously installed during installation. |
Example
mgnl tab-completion install
search
Searches for Magnolia-related packages available from npm and returns their list together with the following information:
- Package name.
- Date and version of the latest commit.
- Brief description of the package.
- Contributor's username.
Usage
mgnl search [options]
Options
| Option | Description |
|---|---|
<query> | optional The search query sent to the npm's API (see https://api-docs.npms.io). The query can contain multiple terms separated with commas and no spaces. If you do not provide a query option, the command returns a list of all light modules. |
Example
mgnl search language-switcherinfo 1 result foundinfo info 1) language-switcher-magnoliainfo 2017-02-25 1.0.5info Language Switcher - Component template for Magnolia CMSinfo magnolia
start
This command starts up Magnolia and displays the main log file (apache-tomcat/logs/catalina.out). Magnolia CLI looks in the current working directory or parent directories for the nearest folder with a name that starts with "apache-tomcat". To stop Magnolia, simply use CTRL+C.
Usage
mgnl start [options]
Options
| Short form | Long form | Description |
|---|---|---|
-p <path> | --path <path> | optional The path to the |
-d | optional Does NOT ignore the open files limit check. The files limit check is ignored by default. See Too many open files for more. |
Example
mgnl start -p C:/magnolia-installations/magnolia-5.5.1/apache-tomcat-8.5.5
