Angular CLI - ng new Command

Quiz

The ng new command creates a workspace of given name with a default Angular Application. It provides interactive prompts to set optional configurations. All prompts have default values to choose.

This chapter explains the syntax, argument and options of ng new command along with an example.

Syntax

The syntax for ng new command is as follows −

ng new <name> [options]
Or,
ng n <name> [options]

Argument

The argument for ng new command is as follows −

Sr.No.	Argument & Syntax	Description
1	<name>	It specifies the name of angular project you want to create. It will be the root directory.

Options

Following are the optional parameters of ng new command −

Sr.No.	Option & Syntax	Description
1	--collection=collection	It is a collection of schematics of type String used in generating the initial application. Aliases: -c.
2	--commit=true\|false	Initial git repository commit information. It is of type boolean and its default value is "true".
3	--createApplication=true\|false	When "true" (the default value), it creates a new initial app project in the "src" folder of the new workspace. When false, creates an empty workspace with no initial app. You can then use ng generate application command so that all apps are created in the projects folder.
4	-defaults=true\|false	When "true", disables interactive input prompts for options with a default. Its default value is "false".
5	--directory=directory	The directory name to create the workspace in. If not specified, the workspace will be created inside current directory.
6	--dryRun=true\|false	When "true", runs through and reports activity without writing out results. Default: false. Aliases: -d.
7	--force=true\|false	When "true", forces overwriting of existing files. Default: false. Aliases: -f.
8	--help=true\|false\|json\|JSON	Use it, if you want some help regarding ng new command. It shows a help message in the console. Default: false.
9	--inline-style=true\|false	When "true", includes styles inline in the component TS file. By default, an external styles file is created and referenced in the component TS file. Default: false. Aliases: -s.
10	--inline-template=true\|false	When "true", includes HTML template inline in the component TS file. By default, an external HTML template file is created and referenced in the component TS file. Default: false. Aliases: -t.
11	--interactive=true\|false	It is used to enable interactive input prompts. Default: true.
12	--newProjectRoot=newProjectRoot	The path where new projects will be created, relative to the new workspace root. It is of type String. Default: projects.
13	--packageManager=npm\|yarn\|pnpm\|cnpm	It installs dependencies. The name of dependencies are specified in the form of String.
14	--prefix=prefix	The specified prefix (of the type String) will be applied to generated selectors for the initial project. Default: app. Aliases: -p.
15	--experimental-zoneless	It is of boolean type. If it is "true", the initial application will be created without utilizing zone.js Default: false.
16	--routing=true\|false	It generates a routing module and other necessary files to navigate between different views.
17	--skip-git=true\|false	When "true", does not initialize a git repository. By default, a Git repo is initialized. Default: false. Aliases: -g.
18	--skip-install=true\|false	When "true", does not install dependency packages. Default: false.
19	--skip-tests=true\|false	When "true", does not generate "spec.ts" test files for the new project. Default: false. Aliases: -S.
20	--strict=true\|false	Creates a workspace with stricter TypeScript compiler options. Default: true.
21	--style=css\|scss\|sass\|less\|styl	The file extension or preprocessor to use for style files.
22	--minimal=true\|false	When true, creates a project without any testing frameworks. (Use for learning purposes only.) Default: false.
23	-- viewEncapsulation=Emulated\|Native\|None\|ShadowDom	The view encapsulation strategy to use in the initial project.
24	--server-routing	When specified, it creates a server application in the initial project. It is in Developer Preview.
25	--ssr	Use this option to configure the initial application for Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering).
26	--standalone	By default, Angular CLI creates an application based upon the standalone API, without NgModules.

Example

Let's see an example of ng new command. Here, we use this command to create an angular workspace and a project with name TutorialsPoint in our Angular directory.

PS D:\Angular> ng new TutorialsPoint
? Which stylesheet format would you like to use? (Use arrow keys)
  CSS             [ https://developer.mozilla.org/docs/Web/CSS                     ]
  Sass (SCSS)     [ https://sass-lang.com/documentation/syntax#scss                ]
  Sass (Indented) [ https://sass-lang.com/documentation/syntax#the-indented-syntax ]
  Less            [ http://lesscss.org                                             ]
? Do you want to enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering)? (y/N)
CREATE TutorialsPoint/angular.json (2719 bytes)
CREATE TutorialsPoint/package.json (1087 bytes)
CREATE TutorialsPoint/README.md (1103 bytes)
CREATE TutorialsPoint/tsconfig.json (1045 bytes)
CREATE TutorialsPoint/.editorconfig (331 bytes)
CREATE TutorialsPoint/.gitignore (629 bytes)
CREATE TutorialsPoint/tsconfig.app.json (439 bytes)
CREATE TutorialsPoint/tsconfig.spec.json (449 bytes)
CREATE TutorialsPoint/.vscode/extensions.json (134 bytes)
CREATE TutorialsPoint/.vscode/launch.json (490 bytes)
CREATE TutorialsPoint/.vscode/tasks.json (980 bytes)
CREATE TutorialsPoint/src/main.ts (256 bytes)
CREATE TutorialsPoint/src/index.html (313 bytes)
CREATE TutorialsPoint/src/styles.css (81 bytes)
CREATE TutorialsPoint/src/app/app.component.html (20239 bytes)
CREATE TutorialsPoint/src/app/app.component.spec.ts (969 bytes)
CREATE TutorialsPoint/src/app/app.component.ts (323 bytes)
CREATE TutorialsPoint/src/app/app.component.css (0 bytes)
CREATE TutorialsPoint/src/app/app.config.ts (318 bytes)
CREATE TutorialsPoint/src/app/app.routes.ts (80 bytes)
CREATE TutorialsPoint/public/favicon.ico (15086 bytes)
â Packages installed successfully.

Print Page