A tool to setup and facilitate light development with Magnolia CMS

Usage no npm install needed!

<script type="module">
  import magnoliaCli from 'https://cdn.skypack.dev/@magnolia/cli';


Magnolia Light Development CLI tool

license Build Status

An npm package providing a CLI tool to setup and facilitate light development with Magnolia. For a complete reference including installation and usage please visit Magnolia CLI documentation.

Version 4.0.0

All users of Magnolia 6.2.x are recommended to upgrade to CLI 4.0.0

  • The create commands now generate Magnolia 6 UI definitions by default. Since these definitions are incompatible with Magnoila 5 UI, we update the CLI to new major version (4.0). https://jira.magnolia-cms.com/browse/NPMCLI-236
  • The dialog definitions of component and page templates and the app definition are affected by the change.
  • You can still generate the 5 UI definitions with the create commands by using the -P or --prototype flag to specify one of the m5 prototypes.
  • As a convenience, if the CLI can detect that the current location is used by a < 6.2.x version of Magnolia, then it will use the _default-m5 prototypes automatically.
    • The CLI can detect the Magnolia version when the 'light-modules' directory is adjacent to an 'apache-tomcat' directory, as is the case when Magnolia is installed with mgnl jumpstart command.
  • If you would like the CLI to generate 5 UI definitions by default for certain projects, you can use the customize-local-config command which generates a local version of all of the prototypes used in the create commands. Then you can change the prototypes to suit your needs. (Such as renaming the _default-m5 prototypes to _default.)
  • Problem with jumpstart command fixed: 'ERR! Cannot read property 'status' of undefined' https://jira.magnolia-cms.com/browse/NPMCLI-239

Version 3.1.0

Users on prior versions of the CLI are encouraged to upgrade to 3.1

Version 3.0.7

Version 3.0.6

Version 3.0.5

Version 3.0.4

Version 3.0.3

Version 3.0.2

  • unpublished due to an issue with npmjs.org

Version 3.0.1

Version 3.0.0

  • A new prototype structure has been introduced, see Prototypes in CLI v3 and also Updating CLI to v3 for migration of prototypes from CLI v2 to CLI v3.
  • The jumpstart command has been significantly improved. It now provides a list of available webapps you can choose from.
  • Two new commands have been added:
    • create-block - creates a block definition
    • create-virtual-uri - creates a virtual uri mapping definition

Major changes

(For a full list of changes please see the release history).

Version 2.2.0

  • A new option -c (--cloud) has been added to the jumpstart command. The mgnl jumpstart --cloud will download and setup a Magnolia Cloud Enterprise bundle. It requires credentials to access Magnolia Nexus.

Version 2.1.0

  • Two new commands have been added:
    • search - to discover light modules on the npm site
    • install - to easily install a light module from the registry into your light modules folder

version 2.0

  • The setup command has been replaced with customize-local-config (or its alias customise-local-config, yes with an s instead of z) because we thought it was a better name :).