## 用法 ### CLI命令参考 ### nest new 创建一个新的(标准模式)Nest项目。 ```bash $ nest new <name> [options] $ nest n <name> [options] ``` 描述 创建并初始化一个新的 `Nest` 项目。提示使用包管理器。 - 创建具有给定的文件夹 - 用配置文件填充文件夹 - 为源代码( `/src` )和端到端测试( `/test` )创建子文件夹 - 用应用程序组件和测试的默认文件填充子文件夹 参数 |参数 | 描述 | |---|---| | `<name>` |新项目的名称| 选项 |选项|描述| |---|---| | `--dry-run` |报告将要进行的更改，但不更改文件系统。 别名:- d| |`--skip-git`|跳过 `git` 存储库初始化。别名:- g| |`--skip-install`|跳过软件包安装。 别名：-s| |`--package-manager [package-manager]`| 指定包管理器。使用 `npm` 或 `yarn`。必须全局安装包管理器。别名: -p| |`--language [language]` |指定编程语言(`TS` 或 `JS`)。别名:- l| |`--collection [collectionName]`| 指定逻辑示意图集合。 使用已安装的包含原理的 `npm` 软件包的软件包名称。别名：-c| ### nest generate 根据原理图生成或修改文件 ```bash $ nest generate <schematic> <name> [options] $ nest g <schematic> <name> [options] ``` 参数 |参数 | 描述 | |---|---| |`<schematic>`| 原理图或集合:生成原理图。可用的示意图见下表。| | `<name>` |生成的组件的名称。| Schematics |名称|别名|描述| |---|---|---| |`app`||在 `monorepo` 中生成一个新应用程序(如果它是一个标准结构，则转换为 `monorepo`)。| |`library`|`lib`|在 `monorepo` 中生成一个新库(如果是标准结构，则转换为 `monorepo` )。| |`class`| `cl`|生成一个新类。| |`controller`|`co`|生成控制器声明| |`decorator` |`d`| 生成自定义装饰器。| |`filter`|`f`|生成过滤器声明。| |`gateway`| `ga`|生成网关声明。| |`guard`|`gu`|生成守卫声明。| |`interface`||生成一个接口。| |`interceptor`|`in`|生成一个拦截器声明。| |`middleware`|`mi`|生成中间件声明。| |`module`|`mo`|生成模块声明。| |`pipe`|`pi`|生成管道声明。| |`provider`|`pr`|生成提供者声明。| |`resolver`|`r`|生成解析器声明。| |`service`|`s`|生成服务声明。| 选项： |选项|描述| |---|--| |`--dry-run`| 报告将要进行的更改，但不更改文件系统。别名:- d| |`--project [project]`|应该将该元素添加到项目中。别名:-p| |`--flat`|不要为元素生成文件夹。| |`--collection [collectionName]`|指定逻辑示意图集合。 使用已安装的包含原理图的npm软件包的软包名称。别名：-c| |`--spec`|强制spec文件生成（默认）| |`--no-spec`|禁用spec文件生成| ### nest build 将应用程序或工作区编译到输出文件夹中。 ```bash $ nest build <name> [options] ``` 参数 |参数 | 描述 | |---|---| |`<name>`|要构建的项目的名称。| 选项： |选项|描述| |---|--| |`--path [path]`| `tsconfig`文件的路径。别名: `-p`| |`--watch`| 在监视模式下运行（实时重载）别名-w| |`--webpack`|使用 `webpack` 进行编译。| |`--webpackPath`|配置 `webpack` 的路径。| |`--tsc`|强制使用 `tsc` 编译。| ### nest start 编译并运行应用程序(或工作空间中的默认项目)。 ```bash $ nest start <name> [options] ``` 参数 |参数 | 描述 | |---|---| |`<name>`|要运行的项目的名称。| 选项： |选项|描述| |---|--| |`--path [path]`| `tsconfig`文件的路径。别名: `-p`| |`--config [path]`| `nest-cli`配置文件的路径。别名: `-c`| |`--watch`| 在监视模式下运行（实时重载）别名-w| |`--preserveWatchOutput`| 在watch模式下，保存命令行输出内容而不是清空屏幕（仅在`tsc watch`模式下)| |`--watchAssets`| 运行在watch模式下（热重载），监控非TS文件（资源文件），见**资源文件**了解更多细节| |`--debug [hostport]`| 在debug模式运行（使用--inspect标识），别名-d| |`--webpack`|使用 `webpack` 进行编译。| |`--webpackPath`|webpack配置路径。| |`--tsc`|强制使用 `tsc` 编译。| |`--exec [binary]`|要运行的二进制文件（默认：`node`）。别名: `-e`| ### nest add 导入一个已打包为 `nest库`的库，运行其安装示意图;导入一个已打包为 `nest` 库的库，运行其安装示意图 ```bash $ nest add <name> [options] ``` 选项： |选项|描述| |---|--| |`<name>`|要导入的库的名称。| ### nest update 将 `package.json` “依赖项”列表中的 `@nestjs` 依赖项更新为其 `@latest` 版本。 选项： |选项|描述| |---|--| |`--force`|做升级而不是更新别名: -f| |`--tag`|更新为标记版本（使用 `@latest`，`@<tag>`等）别名-wt| ### nest info 显示nest安装的包和其他有用的系统信息，例如： ```bash _ _ _ ___ _____ _____ _ _____ | \ | | | | |_ |/ ___|/ __ \| | |_ _| | \| | ___ ___ | |_ | |\ `--. | / \/| | | | | . ` | / _ \/ __|| __| | | `--. \| | | | | | | |\ || __/\__ \| |_ /\__/ //\__/ /| \__/\| |_____| |_ \_| \_/ \___||___/ \__|\____/ \____/ \____/\_____/\___/ [System Information] OS Version : macOS High Sierra NodeJS Version : v8.9.0 YARN Version : 1.5.1 [Nest Information] microservices version : 6.0.0 websockets version : 6.0.0 testing version : 6.0.0 common version : 6.0.0 core version : 6.0.0 ```