Nest CLI是一个命令行界面工具,以帮助您初始化、开发和维护 Nest
应用程序。它以多种方式提供帮助,包括搭建项目、以开发模式为其提供服务,以及为生产分发构建和打包应用程序
基本工作流
您应该能够通过 nest
可执行文件直接从命令行调用 CLI
命令。
1 | $ nest --help |
使用以下结构获取有关单个命令的帮助。 替换任何命令,例如 new
,add
等,在下面的示例中看到的 generate
可以获取有关该命令的详细帮助:
1 | $ nest generate --help |
要在开发模式下创建、构建和运行新的基本 Nest
项目,请转到父项目的文件夹下,并运行以下命令:
1 | $ nest new my-nest-project |
在浏览器中,打开 http://localhost:3000
查看新应用程序的运行情况。当您更改任何源文件时,应用程序将自动重新编译和重新加载。
CLI 命令语法
所有的 nest
命令都遵循相同的格式:
1 | nest commandOrAlias requiredArg [optionalArg] [options] |
例如:
1 | $ nest new my-nest-project --dry-run |
在这里,new
是命令或别名。 新命令的别名为n. my-nest-project
是必需的参数。 如果命令行上未提供所需的参数,则 nest
将提示您输入。 同样,--dry-run
也有一个类似的简写形式 -d
。 考虑到这一点,以下命令与上面的命令等效:
1 | $ nest n my-nest-project -d |
大多数命令和一些选项都有别名。尝试运行 nest new --help
查看这些选项和别名,并确认您对上述构造的理解。
常用命令
1 | $ nest g module user # 创建user模块 |