W3cubDocs

/Angular

ng new

Create an Angular workspace.

ng new <name> [options]

ng n <name> [options]

Description

Creates and initializes a new Angular application that is the default project for a new workspace.

Provides interactive prompts for optional configuration, such as adding routing support. All prompts can safely be allowed to default.

  • The new workspace folder is given the specified project name, and contains configuration files at the top level.

  • By default, the files for a new initial application (with the same name as the workspace) are placed in the src/ subfolder.

  • The new application's configuration appears in the projects section of the angular.json workspace configuration file, under its project name.

  • Subsequent applications that you generate in the workspace reside in the projects/ subfolder.

If you plan to have multiple applications in the workspace, you can create an empty workspace by setting the --create-application option to false. You can then use ng generate application to create an initial application. This allows a workspace name different from the initial app name, and ensures that all applications reside in the /projects subfolder, matching the structure of the configuration file.

Arguments

Argument Description Value Type
<name>

The name of the new workspace and initial project.

string

Options

Option Description Value Type Default Value
--collection

A collection of schematics to use in generating the initial application.

Aliases: -c

string
--commit

Initial git repository commit information.

boolean true
--create-application

Create a new initial application project in the 'src' folder of the new workspace. When false, creates an empty workspace with no initial application. You can then use the generate application command so that all applications are created in the projects folder.

boolean true
--defaults

Disable interactive input prompts for options with a default.

boolean
--directory

The directory name to create the workspace in.

string
--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.

true|false|json|JSON false
--inline-style

Include styles inline in the component TS file. By default, an external styles file is created and referenced in the component TypeScript file.

Aliases: -s

boolean
--inline-template

Include template inline in the component TS file. By default, an external template file is created and referenced in the component TypeScript file.

Aliases: -t

boolean
--interactive

Enable interactive input prompts.

boolean
--minimal

Create a workspace without any testing frameworks. (Use for learning purposes only.)

boolean false
--new-project-root

The path where new projects will be created, relative to the new workspace root.

string projects
--package-manager

The package manager used to install dependencies.

npm|yarn|pnpm|cnpm
--prefix

The prefix to apply to generated selectors for the initial project.

Aliases: -p

string app
--routing

Generate a routing module for the initial project.

boolean
--skip-git

Do not initialize a git repository.

Aliases: -g

boolean false
--skip-install

Do not install dependency packages.

boolean false
--skip-tests

Do not generate "spec.ts" test files for the new project.

Aliases: -S

boolean false
--strict

Creates a workspace with stricter type checking and stricter bundle budgets settings. This setting helps improve maintainability and catch bugs ahead of time. For more information, see https://angular.io/guide/strict-mode

boolean true
--style

The file extension or preprocessor to use for style files.

css|scss|sass|less
--verbose

Add more details to output logging.

Aliases: -v

boolean false
--view-encapsulation

The view encapsulation strategy to use in the initial project.

Emulated|None|ShadowDom

© 2010–2021 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/cli/new