docs: additional documentation around cli generators (#711)

postlight · Jun 17, 2017 · 2327c13 · 2327c13
1 parent 1691f9a
commit 2327c13
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/bin/lux b/bin/lux
@@ -148,7 +148,7 @@ cli
 cli
   .command('g <type> <name> [attrs...]')
   .alias('generate')
-  .description('Example: lux generate model user')
+  .description('Example: lux generate model user name:string email:string admin:boolean')
   .action((type, name, attrs) => {
     exec('generate', { type, name, attrs })
       .then(exit)

diff --git a/guide/getting-started.md b/guide/getting-started.md
@@ -12,6 +12,22 @@ Use the new command to create your first project.
 lux new <app-name>
 ```
 
+### Generators
+
+Lux allows you to use the CLI to generate boilerplate for the following types:
+
+- `model`
+- `controller`
+- `serializer`
+- `middleware`
+- `migration`
+- `resource`
+- `util`
+
+```bash
+lux generate <type> <name> [attrs...]
+```
+
 ### Running
 
 To run your application use the serve command.