Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Magnolia CLI


Magnolia CLI is an npm package providing a CLI tool to setup and facilitate Light Development with Magnolia.

Installs the mgnl command which allows performing several key operations for Light Development. It enables creating modules, pages, and components without any special IDE or Java requirements

Advantages of Magnolia CLI

Light modules, page, area, and component templates are created automatically.

There is no need to restart the server.

Magnolia CLI Commands


 -v, --version           output the version number

 -h, --help                output usage information


 jumpstart                   download and setup a Magnolia CMS instance for development.

 start                       start up a Magnolia CMS instance. To stop it, enter CTRL+C

 add-availability            add component availability.

 build                       scans for "magnolia-light-module" and extract to a directory    

 create-block                create a block.

 create-component            create a component and optionally add availability for it.

 create-light-module         create a light module.

 create-page                 create a page template.

 create-virtual-uri          create a virtual uri mapping.

 Customize-local-config    extract "mgnl-cli-prototypes" folder and "mgnl-cli.json" file

 install                     install a light module from npm to the local Magnolia instance.

 search                      search for a light module on npm.

 tab-completion              install tab autocomplete feature for Bash, zsh or PowerShell

 version                     display mgnl and node.js versions

 help [cmd]                  display help for [cmd]



  • No labels