JumpstartPlugin

A plugin for Magnolia CLI to download and set up a new headless or freemarker-based project with Magnolia webapp

Installation

Within the Magnolia CLI plugin system, this plugin is pre-installed and ready to be used.

Usage

jumpstart [name] [options]

Arguments

| Argument | Description | |----------|-------------------------------------------------------------------------------------------------| | name | Optional project directory name. If provided, the project will be created in this directory. |

Options

| Short | Long | Description | |----------------|--------------------------------|-------------------------------------------------------------------------------| | -m <version> | --magnolia <version> | set the Magnolia version; defaults to the latest stable version | | -s | --snapshot | download the latest snapshot version of the specified or latest stable webapp | | -t <name> | --template <name> | choose a template from available project templates | | -p <source> | --project-templates <source> | specify the source to load project templates from | | -v | --version | output the version number | | -h | --help | display help for command |

Examples

Jumpstart a project in current directory

npx @magnolia/cli@latest jumpstart

This command will prompt you with a list of available templates to choose from. Once you select a template, the CLI will download and configure the project in the current working directory with the latest Magnolia version (or with version associated with that template).

Jumpstart a project in a new directory

npx @magnolia/cli@latest jumpstart my-project

This command will create a new directory called my-project (if it doesn't exist) and set up the project inside it.

Jumpstart a project with specific template

npx @magnolia/cli@latest jumpstart --template "standard-webapps/magnolia-community-webapp"

This command will start downloading and configuring project based on "standard-webapps/magnolia-community-webapp" template with latest Magnolia version.

Jumpstart a project with specific template and specific magnolia version

npx @magnolia/cli@latest jumpstart --template "standard-webapps/magnolia-community-webapp" --magnolia "6.2.11"

This command will start downloading and configuring project based on "standard-webapps/magnolia-community-webapp" template with 6.2.11 Magnolia version.

Jumpstart a project in a specific directory with template and version

npx @magnolia/cli@latest jumpstart my-magnolia-app --template "standard-webapps/magnolia-community-webapp" --magnolia "6.2.11"

This command will create the my-magnolia-app directory (if needed) and set up the project with the specified template and Magnolia version.

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