CLI reference page
(DOCU-755)
|
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 5.5, 5.4.x |
| Type: | Sub-task | Priority: | Neutral |
| Reporter: | Christoph Meier | Assignee: | Martin Drápela |
| Resolution: | Done | Votes: | 0 |
| Labels: | core | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Environment: |
Linux |
||
| Template: |
|
| Date of First Response: | |
| Sprint: | Docu Sprint 11 |
| Description |
|
Read (beginning of) https://documentation.magnolia-cms.com/display/DOCS/Magnolia+npm-cli and please follow the installation instructions until you have a running version of the Magnolia npm-cli tools mdrapela, please check whether you find differences in what i have written while i was using OS-X. Feel free just to edit contents - if required. Try out the commands help and create-light-module, but please do not edit the commands section of the page yet. |
| Comments |
| Comment by Martin Drápela [ 26/Jul/16 ] |
|
The installation of node.js was unfortunately a little more complicated than straightforward so I include the commands that finally lead me to the expected "v4.4.7" output of the "node -v" command: mkdir Downloads The command sudo npm install @magnolia/cli --registry=https://npm.magnolia-cms.com/repository/npm -g produced the following output with one warning at the beginning: npm WARN deprecated minimatch@0.2.14: Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue mgnl -h command produced the expected result. As for the "source" line for autocompletion, I had to put it into .bashrc cause my bash didn't read it from .profile. |
| Comment by Christoph Meier [ 27/Jul/16 ] |
|
mdrapela, i was changing the vislibility of your Linix specific comments. The installation hints i have added to Appendix - not sure whether that's fine in the general, theoretical tech.-writing meaning of an Appendix. However - i have done it like this for the moment. I don't want to have a separate node installation section for every OS. But since your findings are helpful i wanted them to have available. |
| Comment by Martin Drápela [ 08/Aug/16 ] |
|
The mgnl create-light-module <module-name> command will create the following tree structure for the <module-name>: <module-name>
├── decorations
├── dialogs
│ ├── components
│ └── pages
├── i18n
│ └── <module-name>-messages_en.properties
├── templates
│ ├── components
│ └── pages
└── webresources
├── css
└── js
The <module-name>-messages_en.properties file will contain a link to the https://documentation.magnolia-cms.com/display/DOCS/Internationalization page. Next, if e.g. the mgnl create-page page1 is entered, the module tree will look like as follows: <module-name>
├── decorations
├── dialogs
│ ├── components
│ └── pages
│ └── page1.yaml
├── i18n
│ └── <module-name>-messages_en.properties
├── templates
│ ├── components
│ └── pages
│ ├── page1.ftl
│ └── page1.yaml
└── webresources
├── css
└── js
|