Merge pull request nestjs#67 from nestjs/docs-cli

CLI documentation
duard · Apr 28, 2018 · a662c49 · a662c49
2 parents 5537b7a + 47f8a78
commit a662c49
Showing 1 changed file with 28 additions and 14 deletions.
diff --git a/src/app/homepage/pages/cli/usages/usages.component.html b/src/app/homepage/pages/cli/usages/usages.component.html
@@ -15,7 +15,7 @@ <h4>Options</h4>
       <strong>--dry-run</strong>: allows to simulate the command execution in order to verify how it will affect your working directory
     </li>
   </ul>
-  <h4>new</h4>
+  <h4>new (alias n)</h4>
   <p>
     The
     <strong>new</strong> command generates a Nest project based on the <a href="https://github.com/nestjs/typescript-starter" target="blank">typescript-starter</a> as well as install the required packages.
@@ -54,7 +54,14 @@ <h4>new</h4>
       <td>''</td>
     </tr>
   </table>
-  <h4>generate</h4>
+  <p>
+    Example usage:
+  </p>
+  <pre><code class="language-bash">
+$ nest new my-awesome-app</code>
+OR <code class="language-bash">
+$ nest n my-awesome-app</code></pre>
+  <h4>generate (alias g)</h4>
   <p>
     The
     <strong>generate</strong> command generates a Nest architecture component.
@@ -87,28 +94,35 @@ <h4>generate</h4>
   </table>
   <p>A list of available architecture components:</p>
   <ul>
-    <li>controller</li>
-    <li>exception</li>
-    <li>guard</li>
-    <li>interceptor</li>
-    <li>middleware</li>
-    <li>module</li>
-    <li>pipe</li>
-    <li>service</li>
+    <li>class       (alias cl)</li>
+    <li>controller  (alias co)</li>
+    <li>decorator   (alias d)</li>
+    <li>exception   (alias e)</li>
+    <li>filter      (alias f)</li>
+    <li>gateway     (alias ga)</li>
+    <li>guard       (alias gu)</li>
+    <li>interceptor (alias i)</li>
+    <li>middleware  (alias mi)</li>
+    <li>module      (alias mo)</li>
+    <li>pipe        (alias pi)</li>
+    <li>provider    (alias pr)</li>
+    <li>service     (alias s)</li>
   </ul>
   <p>
     Example usage:
   </p>
   <pre><code class="language-bash">
-$ nest generate service users</code></pre>
-  <h4>info</h4>
+$ nest generate service users</code>
+OR <code class="language-bash">
+$ nest g s users</code></pre>
+  <h4>info (alias i)</h4>
   <p>
     The
     <strong>info</strong> command will display your project information.
   </p>
   <pre><code class="language-bash">
 $ nest info
-  _   _             _      ___  _____  _____  _     _____
+ _   _             _      ___  _____  _____  _     _____
 | \ | |           | |    |_  |/  ___|/  __ \| |   |_   _|
 |  \| |  ___  ___ | |_     | |\ `--. | /  \/| |     | |
 | . ` | / _ \/ __|| __|    | | `--. \| |    | |     | |
@@ -126,4 +140,4 @@ <h4>info</h4>
 common version        : 5.0.0
 core version          : 5.0.0</code>
   </pre>
-</div>
+</div>