Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI documentation #67

Merged
merged 4 commits into from
Apr 28, 2018
Merged

CLI documentation #67

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9d5932a
docs(cli) : update cli information
Apr 21, 2018
482bdfc
docs(cli) : add command aliases
Apr 21, 2018
242b026
docs(cli) : uniformize command aliases
Apr 21, 2018
91bf4f3
feature(cli) : add provider in element list
Apr 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 28 additions & 14 deletions src/app/homepage/pages/cli/usages/usages.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
_ _ _ ___ _____ _____ _ _____
_ _ _ ___ _____ _____ _ _____
| \ | | | | |_ |/ ___|/ __ \| | |_ _|
| \| | ___ ___ | |_ | |\ `--. | / \/| | | |
| . ` | / _ \/ __|| __| | | `--. \| | | | | |
Expand All @@ -126,4 +140,4 @@ <h4>info</h4>
common version : 5.0.0
core version : 5.0.0</code>
</pre>
</div>
</div>