Plugins

Plugins provide the functionality for CLI.

Windows users using PowerShell must enclose the two consecutive hyphens (--) in quotes:

npm run mgnl "--" ...

The following plugins are currently available in this version of CLI:

Name Description and example

Create App plugin

Creates an app.

npm run mgnl -- create-app "my-app"

Create Block plugin

Creates a block.

npm run mgnl -- create-block "my-block"

Create Component plugin

Creates a new component.

npm run mgnl -- create-component "my-component"

Create Content Type plugin

Creates a content type.

npm run mgnl -- create-content-type "my-ct"

Create Light Module plugin

Creates a light module.

npm run mgnl -- create-light-module "my-lm"

Create Page plugin

Creates a page.

npm run mgnl -- create-page "my-page"

Create REST endpoint plugin

Create a REST endpoint configuration in a light module.

npm run mgnl -- create-rest-endpoint

Create Virtual Uri plugin

Create a virtual URI mapping configuration in a light module.

npm run mgnl -- create-virtual-uri "my-vu"

Generate plugin

Generates a basic structure for a new CLI plugin.

npx @magnolia/cli@latest generate-plugin --name "test-plugin"

Jumpstart plugin

Downloads and sets up a new headless or FreeMarker-based project with a Magnolia webapp.

npx @magnolia/cli@latest jumpstart --magnolia "6.2.11"

Start plugin

Starts up Magnolia and displays the logs.

npm run mgnl -- start

Docker Start plugin

Starts Magnolia using Docker and displays the logs.

npm run mgnl -- docker-start

Hybrid to Light Module plugin

Extracts a Hybrid Light Module to the local Light Modules directory.

npm run mgnl -- hybrid-to-lm
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the Magnolia CLI docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules