ng generate

Generates and/or modifies files based on a schematic.

ng generate <schematic> [options]

ng g <schematic> [options]

Arguments

Argument Description Value Type

<schematic>

The schematic or collection:schematic to generate.

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

app-shell
application
class
component
directive
enum
guard
interceptor
interface
library
module
pipe
resolver
service
service-worker
web-worker

string

Options

Option	Description	Value Type	Default Value
`--defaults`	Disable interactive input prompts for options with a default.	`boolean`
`--dry-run`	Run through and reports activity without writing out results. Aliases: -d	`boolean`	`false`
`--force`	Force overwriting of existing files. Aliases: -f	`boolean`	`false`
`--help`	Shows a help message for this command in the console.	false\|json\|JSON	`false`
`--interactive`	Enable interactive input prompts.	`boolean`

Schematic commands

app-shell

ng generate app-shell [options]

ng g app-shell [options]

Generates an app shell for running a server-side version of an app.

Options

Option	Description	Value Type	Default Value
`--app-dir`	The name of the application directory.	`string`	`app`
`--app-id`	The app ID to use in withServerTransition().	`string`	`serverApp`
`--main`	The name of the main entry-point file.	`string`	`main.server.ts`
`--project`	The name of the related client app.	`string`
`--root-module-class-name`	The name of the root module class.	`string`	`AppServerModule`
`--root-module-file-name`	The name of the root module file	`string`	`app.server.module.ts`
`--route`	Route path used to produce the app shell.	`string`	`shell`

application

ng generate application <name> [options]

ng g application <name> [options]

Generates a new basic app definition in the "projects" subfolder of the workspace.

Arguments

Argument	Description	Value Type
`<name>`	The name of the new app.	`string`

Options

Option	Description	Value Type	Default Value
`--inline-style`	Include 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. Aliases: -s	`boolean`
`--inline-template`	Include 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. Aliases: -t	`boolean`
`--legacy-browsers`	Deprecated: Legacy browsers support is deprecated since version 12. For more information, see https://angular.io/guide/browser-support Add support for legacy browsers like Internet Explorer using differential loading.	`boolean`	`false`
`--lint-fix`	Deprecated: Use "ng lint --fix" directly instead. Apply lint fixes after generating the application.	`boolean`
`--minimal`	Create a bare-bones project without any testing frameworks. (Use for learning purposes only.)	`boolean`	`false`
`--prefix`	A prefix to apply to generated selectors. Aliases: -p	`string`	`app`
`--routing`	Create a routing NgModule.	`boolean`	`false`
`--skip-install`	Skip installing dependency packages.	`boolean`	`false`
`--skip-package-json`	Do not add dependencies to the "package.json" file.	`boolean`	`false`
`--skip-tests`	Do not create "spec.ts" test files for the application. Aliases: -S	`boolean`	`false`
`--strict`	Creates an application with stricter bundle budgets settings.	`boolean`	`true`
`--style`	The file extension or preprocessor to use for style files.	scss\|sass\|less	`css`
`--view-encapsulation`	The view encapsulation strategy to use in the new app.	None\|ShadowDom

class

ng generate class <name> [options]

ng g class <name> [options]

Creates a new, generic class definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the new class.	`string`

Options

Option	Description	Value Type	Default Value
`--lint-fix`	Deprecated: Use "ng lint --fix" directly instead. Apply lint fixes after generating the class.	`boolean`	`false`
`--project`	The name of the project.	`string`
`--skip-tests`	Do not create "spec.ts" test files for the new class.	`boolean`	`false`
`--type`	Adds a developer-defined type to the filename, in the format "name.type.ts".	`string`

component

ng generate component <name> [options]

ng g component <name> [options]

Creates a new, generic component definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the component.	`string`

Options

Option	Description	Value Type	Default Value
`--change-detection`	The change detection strategy to use in the new component. Aliases: -c	OnPush	`Default`
`--display-block`	Specifies if the style will contain `:host { display: block; }`. Aliases: -b	`boolean`	`false`
`--export`	The declaring NgModule exports this component.	`boolean`	`false`
`--flat`	Create the new files at the top level of the current project.	`boolean`	`false`
`--inline-style`	Include 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. Aliases: -s	`boolean`	`false`
`--inline-template`	Include template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file. Aliases: -t	`boolean`	`false`
`--lint-fix`	Deprecated: Use "ng lint --fix" directly instead. Apply lint fixes after generating the component.	`boolean`
`--module`	The declaring NgModule. Aliases: -m	`string`
`--prefix`	The prefix to apply to the generated component selector. Aliases: -p	`string`
`--project`	The name of the project.	`string`
`--selector`	The HTML selector to use for this component.	`string`
`--skip-import`	Do not import this component into the owning NgModule.	`boolean`	`false`
`--skip-selector`	Specifies if the component should have a selector or not.	`boolean`	`false`
`--skip-tests`	Do not create "spec.ts" test files for the new component.	`boolean`	`false`
`--style`	The file extension or preprocessor to use for style files.	scss\|sass\|less	`css`
`--type`	Adds a developer-defined type to the filename, in the format "name.type.ts".	`string`	`Component`
`--view-encapsulation`	The view encapsulation strategy to use in the new component. Aliases: -v	None\|ShadowDom

directive

ng generate directive <name> [options]

ng g directive <name> [options]

Creates a new, generic directive definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the new directive.	`string`

Options

Option	Description	Value Type	Default Value
`--export`	The declaring NgModule exports this directive.	`boolean`	`false`
`--flat`	When true (the default), creates the new files at the top level of the current project.	`boolean`	`true`
`--lint-fix`	Deprecated: Use "ng lint --fix" directly instead. Apply lint fixes after generating the directive.	`boolean`
`--module`	The declaring NgModule. Aliases: -m	`string`
`--prefix`	A prefix to apply to generated selectors. Aliases: -p	`string`
`--project`	The name of the project.	`string`
`--selector`	The HTML selector to use for this directive.	`string`
`--skip-import`	Do not import this directive into the owning NgModule.	`boolean`	`false`
`--skip-tests`	Do not create "spec.ts" test files for the new class.	`boolean`	`false`

enum

ng generate enum <name> [options]

ng g enum <name> [options]

Generates a new, generic enum definition for the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the enum.	`string`

Options

Option Description Value Type Default Value

--lint-fix

Deprecated: Use "ng lint --fix" directly instead.

Apply lint fixes after generating the enum.

boolean

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

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

guard

ng generate guard <name> [options]

ng g guard <name> [options]

Generates a new, generic route guard definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the new route guard.	`string`

Options

Option	Description	Value Type	Default Value
`--flat`	When true (the default), creates the new files at the top level of the current project.	`boolean`	`true`
`--implements`	Specifies which interfaces to implement.	`array`
`--lint-fix`	Deprecated: Use "ng lint --fix" directly instead. Apply lint fixes after generating the guard.	`boolean`
`--project`	The name of the project.	`string`
`--skip-tests`	Do not create "spec.ts" test files for the new guard.	`boolean`	`false`

interceptor

ng generate interceptor <name> [options]

ng g interceptor <name> [options]

Creates a new, generic interceptor definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the interceptor.	`string`

Options

Option	Description	Value Type	Default Value
`--flat`	When true (the default), creates files at the top level of the project.	`boolean`	`true`
`--lint-fix`	Deprecated: Use "ng lint --fix" directly instead. Apply lint fixes after generating the interceptor.	`boolean`
`--project`	The name of the project.	`string`
`--skip-tests`	Do not create "spec.ts" test files for the new interceptor.	`boolean`	`false`

interface

ng generate interface <name> <type> [options]

ng g interface <name> <type> [options]

Creates a new, generic interface definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the interface.	`string`
`<type>`	Adds a developer-defined type to the filename, in the format "name.type.ts".	`string`

Options

Option Description Value Type Default Value

--lint-fix

Deprecated: Use "ng lint --fix" directly instead.

Apply lint fixes after generating the interface.

boolean

--prefix A prefix to apply to generated selectors. string

--project The name of the project. string

library

ng generate library <name> [options]

ng g library <name> [options]

Creates a new, generic library project in the current workspace.

Arguments

Argument	Description	Value Type
`<name>`	The name of the library.	`string`

Options

Option	Description	Value Type	Default Value
`--entry-file`	The path at which to create the library's public API file, relative to the workspace root.	`string`	`public-api`
`--lint-fix`	Deprecated: Use "ng lint --fix" directly instead. Apply lint fixes after generating the library.	`boolean`
`--prefix`	A prefix to apply to generated selectors. Aliases: -p	`string`	`lib`
`--skip-install`	Do not install dependency packages.	`boolean`	`false`
`--skip-package-json`	Do not add dependencies to the "package.json" file.	`boolean`	`false`
`--skip-ts-config`	Do 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.	`boolean`	`false`

module

ng generate module <name> [options]

ng g module <name> [options]

Creates a new, generic NgModule definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the NgModule.	`string`

Options

Option	Description	Value Type	Default Value
`--flat`	Create the new files at the top level of the current project root.	`boolean`	`false`
`--lint-fix`	Deprecated: Use "ng lint --fix" directly instead. Apply lint fixes after generating the module.	`boolean`
`--module`	The declaring NgModule. Aliases: -m	`string`
`--project`	The name of the project.	`string`
`--route`	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.	`string`
`--routing`	Create a routing module.	`boolean`	`false`
`--routing-scope`	The scope for the new routing module.	Root	`Child`

pipe

ng generate pipe <name> [options]

ng g pipe <name> [options]

Creates a new, generic pipe definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the pipe.	`string`

Options

Option	Description	Value Type	Default Value
`--export`	The declaring NgModule exports this pipe.	`boolean`	`false`
`--flat`	When true (the default) creates files at the top level of the project.	`boolean`	`true`
`--lint-fix`	Deprecated: Use "ng lint --fix" directly instead. Apply lint fixes after generating the pipe.	`boolean`	`false`
`--module`	The declaring NgModule. Aliases: -m	`string`
`--project`	The name of the project.	`string`
`--skip-import`	Do not import this pipe into the owning NgModule.	`boolean`	`false`
`--skip-tests`	Do not create "spec.ts" test files for the new pipe.	`boolean`	`false`

resolver

ng generate resolver <name> [options]

ng g resolver <name> [options]

Generates a new, generic resolver definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the new resolver.	`string`

Options

Option	Description	Value Type	Default Value
`--flat`	When true (the default), creates the new files at the top level of the current project.	`boolean`	`true`
`--project`	The name of the project.	`string`
`--skip-tests`	Do not create "spec.ts" test files for the new resolver.	`boolean`	`false`

service

ng generate service <name> [options]

ng g service <name> [options]

Creates a new, generic service definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the service.	`string`

Options

Option	Description	Value Type	Default Value
`--flat`	When true (the default), creates files at the top level of the project.	`boolean`	`true`
`--lint-fix`	Deprecated: Use "ng lint --fix" directly instead. Apply lint fixes after generating the service.	`boolean`
`--project`	The name of the project.	`string`
`--skip-tests`	Do not create "spec.ts" test files for the new service.	`boolean`	`false`

service-worker

ng generate service-worker [options]

ng g service-worker [options]

Pass this schematic to the "run" command to create a service worker

Options

Option Description Value Type Default Value

--configuration

Deprecated: No longer has an effect.

The configuration to apply service worker to.

string

--project The name of the project. string

--target The target to apply service worker to. string build

web-worker

ng generate web-worker <name> [options]

ng g web-worker <name> [options]

Creates a new, generic web worker definition in the given or default project.

Arguments

Argument	Description	Value Type
`<name>`	The name of the worker.	`string`

Options

Option	Description	Value Type	Default Value
`--project`	The name of the project.	`string`
`--snippet`	Add a worker creation snippet in a sibling file of the same name.	`boolean`	`true`
`--target`	The target to apply web worker to.	`string`	`build`