@magnolia/cli-jumpstart-plugin
v1.0.2
Published
A plugin for Magnolia CLI to download and set up a new headless or freemarker-based project with Magnolia webapp
Downloads
483
Readme
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
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
npx @magnolia/cli 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 with the latest Magnolia version (or with version associated with that template)
Jumpstart a project with specific template
npx @magnolia/cli 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 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.
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