nest-cli

A progressive Node.js framework for building efficient and scalable server-side applications 🚀

Type object
File match .nestcli.json .nest-cli.json nest-cli.json nest.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/nest-cli/latest.json
Source https://www.schemastore.org/nest-cli.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

language string
Default: "ts"
collection string

Points at the collection of schematics used to generate components. you generally should not change this value.

Default: "@nestjs/schematics"
sourceRoot string

Points at the root of the source code for the single project in standard mode structures, or the default project in monorepo mode structures.

Default: "src"
entryFile string

The entry file where 'nest start' work with. Default to 'main'.

Default: "main"
monorepo boolean

(monorepo only) For a monorepo mode structure, this value is always true.

Default: false
root string

(monorepo only) Points at the project root of the default project.

Default: ""
compilerOptions object

A map with keys specifying compiler options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-compiler-options for details

Default:
{}
10 nested properties
tsConfigPath string

(monorepo only) Points at the file containing the tsconfig.json settings that will be used when nest build or nest start is called without a project option (e.g., when the default project is built or started). 'nest build' will not work as expected without this file.

Default: "tsconfig.build.json"
builder string | object
typeCheck boolean

If true, enable type checking (when SWC is used). See https://docs.nestjs.com/recipes/swc#type-checking for details.

Default: false
webpack boolean

If true, use webpack compiler (deprecated option, use builder instead). If false or not present, use tsc. In monorepo mode, the default is true (use webpack), in standard mode, the default is false (use tsc). See https://docs.nestjs.com/cli/monorepo#cli-properties for details.

Default: false
webpackConfigPath string

Points at a webpack options file. If not specified, Nest looks for the file webpack.config.js.

Default: "webpack.config.js"
plugins PluginItems[]
Default:
[]
assets AssetsOptions[]

Enables automatically distributing non-TypeScript assets whenever a compilation step begins (asset distribution does not happen on incremental compiles in --watch mode). Accept glob-like string and object. See https://docs.nestjs.com/cli/monorepo#assets for details.

Default:
[]
watchAssets boolean

If true, run in watch-mode, watching all non-TypeScript assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property.

Default: false
deleteOutDir boolean

If true, whenever the compiler is invoked, it will first remove the compilation output directory (as configured in tsconfig.json, where the default is ./dist).

Default: false
manualRestart boolean

If true, enables the shortcut rs to manually restart the server.

Default: false
generateOptions object

A map with keys specifying global generate options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details

Default:
{}
3 nested properties
spec boolean | object

If the value is boolean, a value of true enables spec generation by default and a value of false disables it. A flag passed on the CLI command line overrides this setting, as does a project-specific generateOptions setting (more below). If the value is an object, each key represents a schematic name, and the boolean value determines whether the default spec generation is enabled / disabled for that specific schematic. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details.

36 nested properties
application boolean

Generate spec file for application schematics or not.

class boolean

Disable spec file generation for class schematics.

cl boolean

Alias for class

configuration boolean

Generate spec file for configuration schematics or not.

config boolean

Alias for configuration

controller boolean

Generate spec file for controller schematics or not.

co boolean

Alias for controller

decorator boolean

Generate spec file for decorator schematics or not.

d boolean

Alias for decorator

filter boolean

Generate spec file for filter schematics or not.

f boolean

Alias for filter

gateway boolean

Generate spec file for gateway schematics or not.

ga boolean

Alias for gateway

guard boolean

Generate spec file for guard schematics or not.

gu boolean

Alias for guard

interceptor boolean

Generate spec file for interceptor schematics or not.

in boolean

Alias for interceptor

interface boolean

Generate spec file for interface schematics or not.

middleware boolean

Generate spec file for middleware schematics or not.

mi boolean

Alias for middleware

module boolean

Generate spec file for module schematics or not.

mo boolean

Alias for module

pipe boolean

Generate spec file for pipe schematics or not.

pi boolean

Alias for pipe

provider boolean

Generate spec file for provider schematics or not.

pr boolean

Alias for provider

resolver boolean

Generate spec file for resolver schematics or not.

r boolean

Alias for resolver

service boolean

Generate spec file for service schematics or not.

s boolean

Alias for resolver

library boolean

Generate spec file for library schematics or not.

lib boolean

Alias for library

sub-app boolean

Generate spec file for sub-app schematics or not.

app boolean

Alias for sub-app

resource boolean

Generate spec file for resource schematics or not.

res boolean

Alias for resource

flat boolean

If true, all generate commands will generate a flat structure

Default: false
baseDir string

Base directory

Default: ""
projects Record<string, object>
Default:
{}
defaultLibraryPrefix string

Default import prefix for newly generated libraries.

Default: "@app"

Definitions

CompilerOptions object

A map with keys specifying compiler options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-compiler-options for details

tsConfigPath string

(monorepo only) Points at the file containing the tsconfig.json settings that will be used when nest build or nest start is called without a project option (e.g., when the default project is built or started). 'nest build' will not work as expected without this file.

Default: "tsconfig.build.json"
builder string | object
typeCheck boolean

If true, enable type checking (when SWC is used). See https://docs.nestjs.com/recipes/swc#type-checking for details.

Default: false
webpack boolean

If true, use webpack compiler (deprecated option, use builder instead). If false or not present, use tsc. In monorepo mode, the default is true (use webpack), in standard mode, the default is false (use tsc). See https://docs.nestjs.com/cli/monorepo#cli-properties for details.

Default: false
webpackConfigPath string

Points at a webpack options file. If not specified, Nest looks for the file webpack.config.js.

Default: "webpack.config.js"
plugins PluginItems[]
Default:
[]
assets AssetsOptions[]

Enables automatically distributing non-TypeScript assets whenever a compilation step begins (asset distribution does not happen on incremental compiles in --watch mode). Accept glob-like string and object. See https://docs.nestjs.com/cli/monorepo#assets for details.

Default:
[]
watchAssets boolean

If true, run in watch-mode, watching all non-TypeScript assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property.

Default: false
deleteOutDir boolean

If true, whenever the compiler is invoked, it will first remove the compilation output directory (as configured in tsconfig.json, where the default is ./dist).

Default: false
manualRestart boolean

If true, enables the shortcut rs to manually restart the server.

Default: false
AssetsOptions string | object

For finer control, the element can be object.

include string

Glob-like file specifications for the assets to be distributed.

exclude string

Glob-like file specifications for the assets to be excluded from the include list.

outDir string

A string specifying the path (relative to the root folder) where the assets should be distributed. Defaults to the same output directory configured for compiler output.

watchAssets boolean

If true, run in watch mode watching specified assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property.

GenerateOptions object

A map with keys specifying global generate options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details

spec boolean | object

If the value is boolean, a value of true enables spec generation by default and a value of false disables it. A flag passed on the CLI command line overrides this setting, as does a project-specific generateOptions setting (more below). If the value is an object, each key represents a schematic name, and the boolean value determines whether the default spec generation is enabled / disabled for that specific schematic. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details.

36 nested properties
application boolean

Generate spec file for application schematics or not.

class boolean

Disable spec file generation for class schematics.

cl boolean

Alias for class

configuration boolean

Generate spec file for configuration schematics or not.

config boolean

Alias for configuration

controller boolean

Generate spec file for controller schematics or not.

co boolean

Alias for controller

decorator boolean

Generate spec file for decorator schematics or not.

d boolean

Alias for decorator

filter boolean

Generate spec file for filter schematics or not.

f boolean

Alias for filter

gateway boolean

Generate spec file for gateway schematics or not.

ga boolean

Alias for gateway

guard boolean

Generate spec file for guard schematics or not.

gu boolean

Alias for guard

interceptor boolean

Generate spec file for interceptor schematics or not.

in boolean

Alias for interceptor

interface boolean

Generate spec file for interface schematics or not.

middleware boolean

Generate spec file for middleware schematics or not.

mi boolean

Alias for middleware

module boolean

Generate spec file for module schematics or not.

mo boolean

Alias for module

pipe boolean

Generate spec file for pipe schematics or not.

pi boolean

Alias for pipe

provider boolean

Generate spec file for provider schematics or not.

pr boolean

Alias for provider

resolver boolean

Generate spec file for resolver schematics or not.

r boolean

Alias for resolver

service boolean

Generate spec file for service schematics or not.

s boolean

Alias for resolver

library boolean

Generate spec file for library schematics or not.

lib boolean

Alias for library

sub-app boolean

Generate spec file for sub-app schematics or not.

app boolean

Alias for sub-app

resource boolean

Generate spec file for resource schematics or not.

res boolean

Alias for resource

flat boolean

If true, all generate commands will generate a flat structure

Default: false
baseDir string

Base directory

Default: ""
GenerateFlatOptions boolean

If true, all generate commands will generate a flat structure

GenerateSpecOptions boolean | object

If the value is boolean, a value of true enables spec generation by default and a value of false disables it. A flag passed on the CLI command line overrides this setting, as does a project-specific generateOptions setting (more below). If the value is an object, each key represents a schematic name, and the boolean value determines whether the default spec generation is enabled / disabled for that specific schematic. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details.

application boolean

Generate spec file for application schematics or not.

class boolean

Disable spec file generation for class schematics.

cl boolean

Alias for class

configuration boolean

Generate spec file for configuration schematics or not.

config boolean

Alias for configuration

controller boolean

Generate spec file for controller schematics or not.

co boolean

Alias for controller

decorator boolean

Generate spec file for decorator schematics or not.

d boolean

Alias for decorator

filter boolean

Generate spec file for filter schematics or not.

f boolean

Alias for filter

gateway boolean

Generate spec file for gateway schematics or not.

ga boolean

Alias for gateway

guard boolean

Generate spec file for guard schematics or not.

gu boolean

Alias for guard

interceptor boolean

Generate spec file for interceptor schematics or not.

in boolean

Alias for interceptor

interface boolean

Generate spec file for interface schematics or not.

middleware boolean

Generate spec file for middleware schematics or not.

mi boolean

Alias for middleware

module boolean

Generate spec file for module schematics or not.

mo boolean

Alias for module

pipe boolean

Generate spec file for pipe schematics or not.

pi boolean

Alias for pipe

provider boolean

Generate spec file for provider schematics or not.

pr boolean

Alias for provider

resolver boolean

Generate spec file for resolver schematics or not.

r boolean

Alias for resolver

service boolean

Generate spec file for service schematics or not.

s boolean

Alias for resolver

library boolean

Generate spec file for library schematics or not.

lib boolean

Alias for library

sub-app boolean

Generate spec file for sub-app schematics or not.

app boolean

Alias for sub-app

resource boolean

Generate spec file for resource schematics or not.

res boolean

Alias for resource

GenerateBaseDirOptions string

Base directory

ProjectConfiguration object
type string
root string
entryFile string
sourceRoot string
compilerOptions object

A map with keys specifying compiler options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-compiler-options for details

Default:
{}
10 nested properties
tsConfigPath string

(monorepo only) Points at the file containing the tsconfig.json settings that will be used when nest build or nest start is called without a project option (e.g., when the default project is built or started). 'nest build' will not work as expected without this file.

Default: "tsconfig.build.json"
builder string | object
typeCheck boolean

If true, enable type checking (when SWC is used). See https://docs.nestjs.com/recipes/swc#type-checking for details.

Default: false
webpack boolean

If true, use webpack compiler (deprecated option, use builder instead). If false or not present, use tsc. In monorepo mode, the default is true (use webpack), in standard mode, the default is false (use tsc). See https://docs.nestjs.com/cli/monorepo#cli-properties for details.

Default: false
webpackConfigPath string

Points at a webpack options file. If not specified, Nest looks for the file webpack.config.js.

Default: "webpack.config.js"
plugins PluginItems[]
Default:
[]
assets AssetsOptions[]

Enables automatically distributing non-TypeScript assets whenever a compilation step begins (asset distribution does not happen on incremental compiles in --watch mode). Accept glob-like string and object. See https://docs.nestjs.com/cli/monorepo#assets for details.

Default:
[]
watchAssets boolean

If true, run in watch-mode, watching all non-TypeScript assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property.

Default: false
deleteOutDir boolean

If true, whenever the compiler is invoked, it will first remove the compilation output directory (as configured in tsconfig.json, where the default is ./dist).

Default: false
manualRestart boolean

If true, enables the shortcut rs to manually restart the server.

Default: false
generateOptions object

A map with keys specifying global generate options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details

Default:
{}
3 nested properties
spec boolean | object

If the value is boolean, a value of true enables spec generation by default and a value of false disables it. A flag passed on the CLI command line overrides this setting, as does a project-specific generateOptions setting (more below). If the value is an object, each key represents a schematic name, and the boolean value determines whether the default spec generation is enabled / disabled for that specific schematic. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details.

36 nested properties
application boolean

Generate spec file for application schematics or not.

class boolean

Disable spec file generation for class schematics.

cl boolean

Alias for class

configuration boolean

Generate spec file for configuration schematics or not.

config boolean

Alias for configuration

controller boolean

Generate spec file for controller schematics or not.

co boolean

Alias for controller

decorator boolean

Generate spec file for decorator schematics or not.

d boolean

Alias for decorator

filter boolean

Generate spec file for filter schematics or not.

f boolean

Alias for filter

gateway boolean

Generate spec file for gateway schematics or not.

ga boolean

Alias for gateway

guard boolean

Generate spec file for guard schematics or not.

gu boolean

Alias for guard

interceptor boolean

Generate spec file for interceptor schematics or not.

in boolean

Alias for interceptor

interface boolean

Generate spec file for interface schematics or not.

middleware boolean

Generate spec file for middleware schematics or not.

mi boolean

Alias for middleware

module boolean

Generate spec file for module schematics or not.

mo boolean

Alias for module

pipe boolean

Generate spec file for pipe schematics or not.

pi boolean

Alias for pipe

provider boolean

Generate spec file for provider schematics or not.

pr boolean

Alias for provider

resolver boolean

Generate spec file for resolver schematics or not.

r boolean

Alias for resolver

service boolean

Generate spec file for service schematics or not.

s boolean

Alias for resolver

library boolean

Generate spec file for library schematics or not.

lib boolean

Alias for library

sub-app boolean

Generate spec file for sub-app schematics or not.

app boolean

Alias for sub-app

resource boolean

Generate spec file for resource schematics or not.

res boolean

Alias for resource

flat boolean

If true, all generate commands will generate a flat structure

Default: false
baseDir string

Base directory

Default: ""
PluginItems string | object
name string

The npm package name of the cli plugin, eg @nestjs/swagger.

options PluginOptions | GraphQLPluginOptions | SwaggerPluginOptions
PluginOptions object
introspectComments boolean

If set to true, plugin will generate descriptions and example values for properties based on comments.

Default: true
GraphQLPluginOptions object
typeFileNameSuffix array

(GraphQL Only) GraphQL types files suffix. Default value: ['.input.ts', '.args.ts', '.entity.ts', '.model.ts']. See https://docs.nestjs.com/graphql/cli-plugin#using-the-cli-plugin for details.

Default:
[
  ".input.ts",
  ".args.ts",
  ".entity.ts",
  ".model.ts"
]
SwaggerPluginOptions object
dtoFileNameSuffix string[]

(Swagger Only) DTO (Data Transfer Object) files suffix. Default value: ['.dto.ts', '.entity.ts']. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

Default:
[
  ".dto.ts",
  ".entity.ts"
]
controllerFileNameSuffix string

(Swagger Only) Controller files suffix. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

Default: ".controller.ts"
classValidatorShim boolean

(Swagger Only) If set to true, the module will reuse class-validator validation decorators (e.g. @Max(10) will add max: 10 to schema definition). See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

Default: true
dtoKeyOfComment string

(Swagger Only) The property key to set the comment text to on ApiProperty. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

Default: "description"
controllerKeyOfComment string

(Swagger Only) The property key to set the comment text to on ApiOperation. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

Default: "description"