| 1 | # Mozu App generator
|
| 2 |
|
| 3 | Maintainer: [James Zetlen](https://github.com/zetlen)
|
| 4 |
|
| 5 | A Mozu App Generator that scaffolds a directory with some basic tools common to all types of Mozu App (Integrations, Extensions/Actions, and Themes).
|
| 6 |
|
| 7 | ## This package is currently a prerelease.
|
| 8 | **This contains pre-release code. It may have behaviors or rely on features that don't work in Mozu production environments. Use with caution!**
|
| 9 |
|
| 10 | 
|
| 11 |
|
| 12 | ## Usage
|
| 13 |
|
| 14 | First, install [Yeoman](http://yeoman.io)'s command line tool if you haven't already!
|
| 15 |
|
| 16 | ```bash
|
| 17 | npm install -g yo
|
| 18 | ```
|
| 19 |
|
| 20 | Yeoman looks for globally installed NPM packages that identify themselves as Yeoman generators. So globally install the mozu-app package!
|
| 21 |
|
| 22 | ```bash
|
| 23 | npm install -g generator-mozu-app
|
| 24 | ```
|
| 25 |
|
| 26 | Make a new directory and `cd` into it:
|
| 27 | ```
|
| 28 | mkdir new-mozu-ext && cd new-mozu-ext
|
| 29 | ```
|
| 30 |
|
| 31 | Run `yo mozu-app`:
|
| 32 | ```
|
| 33 | yo mozu-app
|
| 34 | ```
|
| 35 |
|
| 36 | ## Options
|
| 37 |
|
| 38 | * `--skip-install`
|
| 39 |
|
| 40 | Skips the automatic execution of `npm install` after scaffolding has finished.
|
| 41 |
|
| 42 | * `--skip-prompts`
|
| 43 |
|
| 44 | Often you may find yourself rerunning the generator in the same directory. Your answers to prompts are saved; if you want to quickly re-run the generator without prompts, use this option. Will not work if you've never run the generator in this directory before.
|
| 45 |
|
| 46 | * `--quick`
|
| 47 |
|
| 48 | Equivalent to `--skip-install --skip-prompts`.
|
| 49 |
|
| 50 | * `--internal`
|
| 51 |
|
| 52 | Allows integration with non-production Mozu environments. The prompts will include an extra question about which environment to sync with. |
| \ | No newline at end of file |