ng generate

The schematic or collection:schematic to generate.

This option can take one of the following sub-commands:

• appShell
• application
• class
• component
• directive
• enum
• guard
• interface
• library
• module
• pipe
• service
• serviceWorker
• universal
• webWorker

When true, disables interactive input prompts for options with a default.

When true, runs through and reports activity without writing out results.

Default: false

Aliases: -d

When true, forces overwriting of existing files.

Default: false

Aliases: -f

Shows a help message for this command in the console.

Default: false

When false, disables interactive input prompts.

The name of the application directory.

Default: app

The app ID to use in withServerTransition().

Default: serverApp

The name of the related client app.

The name of the index file

Default: index.html

The name of the main entry-point file.

Default: main.server.ts

The HTML selector of the Universal app

The output directory for build results.

Default: dist-server

The root directory of the app.

Default: src

The name of the root module class.

Default: AppServerModule

The name of the root module file

Default: app.server.module.ts

Route path used to produce the app shell.

Default: shell

The path of the source directory.

Default: src

Aliases: -D

The name of the test entry-point file.

The name of the TypeScript configuration file for tests.

Default: tsconfig.spec

The name of the TypeScript configuration file.

Default: tsconfig.server

The name of related Universal app.

The name of the new app.

EXPERIMENTAL True to create a new app that uses the Ivy rendering engine.

Default: false

When true, includes styles inline in the root component.ts file. Only CSS styles can be included inline. Default is false, meaning that an external styles file is created and referenced in the root component.ts file.

Default: false

Aliases: -s

When true, includes template inline in the root component.ts file. Default is false, meaning that an external template file is created and referenced in the root component.ts file.

Default: false

Aliases: -t

When true, applies lint fixes after generating the application.

Default: false

When true, creates a bare-bones project without any testing frameworks. (Use for learning purposes only.)

Default: false

A prefix to apply to generated selectors.

Default: app

Aliases: -p

When true, creates a routing NgModule.

Default: false

Skip installing dependency packages.

Default: false

When true, does not add dependencies to the "package.json" file.

Default: false

When true, does not create "spec.ts" test files for the app.

Default: false

Aliases: -S

The file extension or preprocessor to use for style files.

Default: css

The view encapsulation strategy to use in the new app.

The name of the new class.

When true, applies lint fixes after generating the class.

Default: false

The name of the project.

When true, does not create "spec.ts" test files for the new class.

Default: false

Deprecated: Use "skipTests" instead.

When true (the default), generates a "spec.ts" test file for the new class.

Default: true

Adds a developer-defined type to the filename, in the format "name.type.ts".

Default:

The name of the component.

The change detection strategy to use in the new component.

Default: Default

Aliases: -c

When true, the new component is the entry component of the declaring NgModule.

Default: false

When true, the declaring NgModule exports this component.

Default: false

When true, creates the new files at the top level of the current project.

Default: false

When true, includes styles inline in the component.ts file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the component.ts file.

Default: false

Aliases: -s

When true, includes template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file.

Default: false

Aliases: -t

When true, applies lint fixes after generating the component.

Default: false

The declaring NgModule.

Aliases: -m

The prefix to apply to the generated component selector.

Aliases: -p

The name of the project.

The HTML selector to use for this component.

When true, does not import this component into the owning NgModule.

Default: false

Specifies if the component should have a selector or not.

Default: false

When true, does not create "spec.ts" test files for the new component.

Default: false

Deprecated: Use "skipTests" instead.

When true (the default), generates a "spec.ts" test file for the new component.

Default: true

The file extension or preprocessor to use for style files.

Default: css

Deprecated: Use "style" instead.

The file extension to use for style files.

Default: css

The view encapsulation strategy to use in the new component.

Aliases: -v

The name of the new directive.

When true, the declaring NgModule exports this directive.

Default: false

When true (the default), creates the new files at the top level of the current project.

Default: true

When true, applies lint fixes after generating the directive.

Default: false

The declaring NgModule.

Aliases: -m

A prefix to apply to generated selectors.

Aliases: -p

The name of the project.

The HTML selector to use for this directive.

When true, does not import this directive into the owning NgModule.

Default: false

When true, does not create "spec.ts" test files for the new class.

Default: false

Deprecated: Use "skipTests" instead.

When true (the default), generates a "spec.ts" test file for the new directive.

Default: true

The name of the enum.

When true, applies lint fixes after generating the enum.

Default: false

The name of the project in which to create the enum. Default is the configured default project for the workspace.

The name of the new route guard.

When true (the default), creates the new files at the top level of the current project.

Default: true

Specifies which interfaces to implement.

When true, applies lint fixes after generating the guard.

Default: false

The name of the project.

When true, does not create "spec.ts" test files for the new guard.

Default: false

Deprecated: Use "skipTests" instead.

When true (the default), generates a "spec.ts" test file for the new guard.

Default: true

The name of the interface.

Adds a developer-defined type to the filename, in the format "name.type.ts".

When true, applies lint fixes after generating the interface.

Default: false

A prefix to apply to generated selectors.

Default:

The name of the project.

The name of the library.

The path at which to create the library's public API file, relative to the workspace root.

Default: public-api

When true, applies lint fixes after generating the library.

Default: false

A prefix to apply to generated selectors.

Default: lib

Aliases: -p

When true, does not install dependency packages.

Default: false

When true, does not add dependencies to the "package.json" file.

Default: false

When true, does not update "tsconfig.json" to add a path mapping for the new library. The path mapping is needed to use the library in an app, but can be disabled here to simplify development.

Default: false

The name of the NgModule.

When true, creates the new files at the top level of the current project root.

Default: false

When true, applies lint fixes after generating the module.

Default: false

The declaring NgModule.

Aliases: -m

The name of the project.

The route path for a lazy-loaded module. When supplied, creates a component in the new module, and adds the route to that component in the Routes array declared in the module provided in the --module option.

When true, creates a routing module.

Default: false

The scope for the new routing module.

Default: Child

The name of the pipe.

When true, the declaring NgModule exports this pipe.

Default: false

When true (the default) creates files at the top level of the project.

Default: true

When true, applies lint fixes after generating the pipe.

Default: false

The declaring NgModule.

Aliases: -m

The name of the project.

When true, does not import this pipe into the owning NgModule.

Default: false

When true, does not create "spec.ts" test files for the new pipe.

Default: false

Deprecated: Use "skipTests" instead.

When true (the default), generates a "spec.ts" test file for the new pipe.

Default: true

The name of the service.

When true (the default), creates files at the top level of the project.

Default: true

When true, applies lint fixes after generating the service.

Default: false

The name of the project.

When true, does not create "spec.ts" test files for the new service.

Default: false

Deprecated: Use "skipTests" instead.

When true (the default), generates a "spec.ts" test file for the new service.

Default: true

The configuration to apply service worker to.

Default: production

The name of the project.

The target to apply service worker to.

Default: build

The name of the application folder.

Default: app

The app identifier to use for transition.

Default: serverApp

The name of the related client app. Required in place of "project".

The name of the main entry-point file.

Default: main.server.ts

The name of the root NgModule class.

Default: AppServerModule

The name of the root NgModule file.

Default: app.server.module.ts

When true, does not install packages for dependencies.

Default: false

The name of the test entry-point file.

The name of the TypeScript configuration file for tests.

Default: tsconfig.spec

The name of the TypeScript configuration file.

Default: tsconfig.server

The name of the worker.

The name of the project.

Add a worker creation snippet in a sibling file of the same name.

Default: true

The target to apply web worker to.

Default: build