W3cubDocs

/Angular

ng build

Compiles an Angular app into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.

ng build <project> [options]

ng b <project> [options]

Description

The command can be used to build a project of type "application" or "library". When used to build a library, a different builder is invoked, and only the ts-config, configuration, and watch options are applied. All other options apply only to building applications.

The application builder uses the webpack build tool, with default configuration options specified in the workspace configuration file (angular.json) or with a named alternative configuration. A "development" configuration is created by default when you use the CLI to create the project, and you can use that configuration by specifying the --configuration development.

The configuration options generally correspond to the command options. You can override individual configuration defaults by specifying the corresponding options on the command line. The command can accept option names given in either dash-case or camelCase. Note that in the configuration file, you must specify names in camelCase.

Some additional options can only be set through the configuration file, either by direct editing or with the ng config command. These include assets, styles, and scripts objects that provide runtime-global resources to include in the project. Resources in CSS, such as images and fonts, are automatically written and fingerprinted at the root of the output folder.

For further details, see Workspace Configuration.

Arguments

Argument Description Value Type
<project>

The name of the project to build. Can be an application or a library.

string

Options

Option Description Value Type Default Value
--allowed-common-js-dependencies

A list of CommonJS packages that are allowed to be used without a build time warning.

array
--aot

Build using Ahead of Time compilation.

boolean true
--base-href

Base url for the application being built.

string
--build-optimizer

Enables '@angular-devkit/build-optimizer' optimizations when using the 'aot' option.

boolean true
--common-chunk

Generate a seperate bundle containing code used across multiple bundles.

boolean true
--configuration

One or more named builder configurations as a comma-separated list as specified in the "configurations" section of angular.json. The builder uses the named configurations to run the given target. For more information, see https://angular.io/guide/workspace-config#alternate-build-configurations. Setting this explicitly overrides the "--prod" flag.

Aliases: -c

string
--cross-origin

Define the crossorigin attribute setting of elements that provide CORS support.

none|anonymous|use-credentials none
--delete-output-path

Delete the output path before building.

boolean true
--deploy-url

Deprecated: Use "baseHref" option, "APP_BASE_HREF" DI token or a combination of both instead. For more information, see https://angular.io/guide/deployment#the-deploy-url.

URL where files will be deployed.

string
--extract-licenses

Extract all licenses in a separate file.

boolean true
--help

Shows a help message for this command in the console.

true|false|json|JSON false
--i18n-missing-translation

How to handle missing translations for i18n.

warning|error|ignore warning
--index

Configures the generation of the application's HTML index.

string
--inline-style-language

The stylesheet language to use for the application's inline component styles.

css|less|sass|scss css
--localize

Translate the bundles in one or more locales.

boolean
--main

The full path for the main entry point to the app, relative to the current workspace.

string
--named-chunks

Use file name for lazy loaded chunks.

boolean false
--ngsw-config-path

Path to ngsw-config.json.

string
--optimization

Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code elimination, inlining of critical CSS and fonts inlining. For more information, see https://angular.io/guide/workspace-config#optimization-configuration.

boolean true
--output-hashing

Define the output filename cache-busting hashing mode.

none|all|media|bundles none
--output-path

The full path for the new output directory, relative to the current workspace.

By default, writes output to a folder named dist/ in the current project.

string
--poll

Enable and define the file watching poll time period in milliseconds.

number
--polyfills

The full path for the polyfills file, relative to the current workspace.

string
--preserve-symlinks

Do not use the real path when resolving modules. If unset then will default to true if NodeJS option --preserve-symlinks is set.

boolean
--prod

Deprecated: Use --configuration production instead.

Shorthand for "--configuration=production". Set the build configuration to the production target. By default, the production target is set up in the workspace configuration such that all builds make use of bundling, limited tree-shaking, and also limited dead code elimination.

boolean
--progress

Log progress to the console while building.

boolean true
--resources-output-path

The path where style resources will be placed, relative to outputPath.

string
--service-worker

Generates a service worker config for production builds.

boolean false
--show-circular-dependencies

Deprecated: The recommended method to detect circular dependencies in project code is to use either a lint rule or other external tooling.

Show circular dependency warnings on builds.

boolean false
--source-map

Output source maps for scripts and styles. For more information, see https://angular.io/guide/workspace-config#source-map-configuration.

boolean false
--stats-json

Generates a 'stats.json' file which can be analyzed using tools such as 'webpack-bundle-analyzer'.

boolean false
--subresource-integrity

Enables the use of subresource integrity validation.

boolean false
--ts-config

The full path for the TypeScript configuration file, relative to the current workspace.

string
--vendor-chunk

Generate a seperate bundle containing only vendor libraries. This option should only used for development.

boolean false
--verbose

Adds more details to output logging.

boolean false
--watch

Run build when files change.

boolean false
--web-worker-ts-config

TypeScript configuration for Web Worker modules.

string

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