# Usage

## Usage

뛰어난 사용자 경험을 제공하기 위해 CLI 명령은 동일한 명령 스키마를 공유합니다.

```bash
$ nest [command] [...options]
```

## Options

각 명령은 아래 나열된 **옵션**을 허용합니다.

* **--dry-run**: 워킹 디렉토리에 미치는 영향을 확인하기 위해 명령 실행을 시뮬레이션 할 수 있습니다.
* **--no-spec**: 스펙 파일의 생성을 끌 수 있습니다 (`generate` 명령에만 적용)
* **--flat**: 전용 디렉토리의 생성을 끌 수 있습니다 (`generate` 명령에만 적용됩니다)

## new (alias: n)

**new** 명령은 [typescript-starter](https://github.com/nestjs/typescript-starter)를 기반으로 Nest 프로젝트를 스캐 폴딩하고 필요한 패키지를 설치합니다. CLI는 누락된 정보 (응용 프로그램 이름 (지정되지 않은 경우) 및 종속성을 설치하는 데 사용하려는 패키지 관리자)를 요청합니다.

```bash
$ nest new my-awesome-app
```

## generate (alias: g)

**generate** 명령은 Nest 아키텍처 구성 요소를 생성합니다.

| Option    | Description                     | Required | Default value |
| --------- | ------------------------------- | -------- | ------------- |
| schematic | 아래 목록에서 스키메틱 이름.                | true     | N/A           |
| name      | 생성된 Nest 아키텍처 구성 요소의 이름입니다.     | false    | N/A           |
| path      | Nest 아키텍처 구성 요소를 생성하기 위한 경로입니다. | false    | src           |

사용 가능한 아키텍처 구성 요소 목록:

* `class` (alias: cl)
* `controller` (alias: co)
* `decorator` (alias: d)
* `filter` (alias: f)
* `gateway` (alias: ga)
* `guard` (alias: gu)
* `interface` (alias: -)
* `interceptor` (alias: in)
* `library` (alias: lib)
* `middleware` (alias: mi)
* `module` (alias: mo)
* `pipe` (alias: pi)
* `provider` (alias: pr)
* `resolver` (alias: r)
* `service` (alias: s)

사용법 예:

```bash
$ nest generate service users
OR
$ nest g s users
```

## info (alias: i)

**info** 명령은 프로젝트 정보를 표시합니다.

```bash
$ nest info
 _   _             _      ___  _____  _____  _     _____
| \ | |           | |    |_  |/  ___|/  __ \| |   |_   _|
|  \| |  ___  ___ | |_     | |\ `--. | /  \/| |     | |
| . ` | / _ \/ __|| __|    | | `--. \| |    | |     | |
| |\  ||  __/\__ \| |_ /\__/ //\__/ /| \__/\| |_____| |_
\_| \_/ \___||___/ \__|\____/ \____/  \____/\_____/\___/

[System Information]
OS Version : macOS High Sierra
NodeJS Version : v8.9.0
YARN Version : 1.5.1
[Nest Information]
microservices version : 5.0.0
websockets version : 5.0.0
testing version : 5.0.0
common version : 5.0.0
core version : 5.0.0
```
