所有 Angular CLI 命令

Angular CLI 是一个命令行工具，用于初始化、开发、脚手架化和维护 Angular 应用程序。您可以直接在命令提示符下使用这些命令，或者通过交互式 UI（即 Angular Console）间接使用。

ng add 命令

ng add 命令用于为您的项目添加对外部库的支持。它将已发布的库的 npm 包添加到您的工作区，并使您的默认应用项目使用该库，具体方式由库的示意图指定。例如，如果您添加 @angular/pwa，它将为 PWA 支持配置您的项目。

默认应用项目是 angular.json 中 defaultProject 的值。

语法

参数解释

<collection>: 指定您要添加的包。

选项

--defaults=true|false: 当为 true 时，它会禁用具有默认值的选项的交互式输入提示。

--help=true|false|json|JSON: 用于在控制台中显示帮助消息。默认值：false

--interactive=true|false: 当为 false 时，它会禁用交互式输入提示。

ng build 命令

ng build 命令用于将 Angular 应用编译到名为 dist/ 的输出目录中，位于指定的输出路径。它必须在工作区目录中执行。

语法

参数解释

<project>: 指定要构建的项目名称。它可以是应用程序或库。

选项

--aot=true|false: 使用预编译 (Ahead of Time) 进行构建。默认值：false

--baseHref=baseHref: 指定正在构建的应用程序的基本 URL。

--buildEventLog=buildEventLog: (实验性) 构建事件协议事件的输出文件路径。

--buildOptimizer=true|false: 使用 'aot' 选项时启用 '@angular-devkit/build-optimizer' 优化。默认值：false

--commonChunk=true|false: 使用一个包含跨多个捆绑包的代码的独立捆绑包。默认值：true

--configuration=configuration: 一个命名的构建目标，如 angular.json 的 "configurations" 部分所指定。每个命名目标都附带一个针对该目标的选项默认值配置。

别名：-c

--deleteOutputPath=true|false: 用于在构建之前删除输出路径。默认值：true

--deployUrl=deployUrl: 文件将被部署到的 URL。

--es5BrowserSupport=true|false: 启用条件加载的 ES2015 polyfills。默认值：false

--extractCss=true|false: 用于将全局样式中的 CSS 提取到 CSS 文件而不是 JS 文件中。默认值：false

--extractLicenses=true|false: 用于将所有许可证提取到单独的文件中。默认值：false

--forkTypeChecker=true|false: 用于在独立的进程中运行 TypeScript 类型检查器。默认值：true

--help=true|false|json|JSON: 用于在控制台中显示此命令的帮助消息。默认值：false

--i18nFile=i18nFile: 用于 i18n 的本地化文件。

--i18nFormat=i18nFormat: --i18n-file 指定的本地化文件的格式。

--i18nLocale=i18nLocale: 用于 i18n 的区域设置。

--i18nMissingTranslation=i18nMissingTranslation: 如何处理 i18n 的翻译缺失。

--index=index: 索引 HTML 文件的名称。

--lazyModules: 将被延迟加载的其他 NgModule 文件列表。延迟路由模块将自动发现。

--main=main: 应用的主入口点的完整路径，相对于当前工作区。

--namedChunks=true|false: 为延迟加载的块使用文件名 默认值：true

--ngswConfigPath=ngswConfigPath: ngsw-config.json 的路径。

--optimization=true|false: 启用构建输出的优化。

--outputHashing= none|all|media|bundles: 定义输出文件名缓存破坏哈希模式。

默认值：none

--outputPath=outputPath: 新输出目录的完整路径，相对于当前工作区。

默认情况下，输出到当前项目中的一个名为 dist/ 的文件夹。

--poll: 以毫秒为单位启用并定义文件监视轮询时间周期。

--polyfills=polyfills: polyfills 文件的完整路径，相对于当前工作区。

--preserveSymlinks=true|false: 解析模块时不要使用真实路径。

默认值：false

--prod=true|false: 当为 true 时，将构建配置设置为生产目标。所有构建都使用捆绑和有限的 tree-shaking。生产构建还执行有限的死代码消除。

--profile=true|false: 输出 Chrome 性能分析器的性能分析事件。

默认值：false

--progress=true|false: 在构建时向控制台记录进度。

--resourcesOutputPath= resourcesOutputPath: 样式资源将被放置的路径，相对于 outputPath。

--serviceWorker=true|false: 为生产构建生成 service worker 配置。默认值：false

--showCircularDependencies=true|false: 在构建时显示循环依赖警告。默认值：true

--sourceMap=true|false: 用于显示输出 source maps。

默认值：true

--statsJson=true|false: 它会生成一个 'stats.json' 文件，可以使用 'webpack-bundle-analyzer' 或 https://webpack.github.io/analyse 等工具进行分析。

默认值：false

--subresourceIntegrity=true|false: 它启用子资源完整性验证的使用。

默认值：false

--tsConfig=tsConfig: TypeScript 配置文件（ts 配置文件）的完整路径，相对于当前工作区。

--vendorChunk=true|false: 它使用一个仅包含供应商库的独立捆绑包。

默认值：true

--verbose=true|false: 它在输出日志中添加更多详细信息。

默认值：false

--watch=true|false: 在文件更改时运行构建。

默认值：false

ng config 命令

ng config 命令用于检索或设置工作区 angular.json 文件中的 Angular 配置值。

语法

参数解释

<jsonPath>: 要设置或查询的配置键，采用 JSON 路径格式。例如："a[3].foo.bar[2]"。如果未提供新值，则返回此键的当前值。

<value>: 如果提供，则为给定配置键的新值。

选项

--global=true|false: 当为 true 时，它会访问调用者主目录中的全局配置。

默认值：false

别名：-g

--help= true|false|json|JSON: 用于在控制台中显示此命令的帮助消息。

默认值：false

ng doc 命令

ng doc 命令用于在浏览器中打开官方 Angular 文档 (angular.io)，并搜索给定的关键字。

语法

参数解释

<keyword>: 用于指定在 angular.io 的搜索栏中提供的搜索关键字。

选项

--help=true|false|json|JSON: 用于在控制台中显示此命令的帮助消息。

--search=true|false: 当为 true 时，它会搜索整个 angular.io。否则，只搜索 API 参考文档。

默认值：false

别名：-s

ng e2e 命令

它用于构建并提供 Angular 应用，然后使用 Protractor 运行端到端测试。

语法

它必须在工作区目录中执行。当您不指定项目名称时，它将为所有项目执行。

参数解释

<project>: 指定您想要构建的项目名称。它可以是应用程序或库。

选项

--baseUrl=baseUrl: 指定 Protractor 连接的基本 URL。

--configuration=configuration: 用于指定命名的构建目标，如 angular.json 的 "configurations" 部分所指定。每个命名目标都附带一个针对该目标的选项默认值配置。

别名：-c

--devServerTarget=devServerTarget: 指定要运行测试的开发服务器目标。

--elementExplorer=true|false: 启动 Protractor 的 Element Explorer 进行调试。

默认值：false

--help= true|false|json|JSON: 在控制台中显示此命令的帮助消息。

默认值：false

--host=host: 要监听的主机。

默认值：localhost

--port: 指定提供应用程序的端口。

--prod=true|false: 当为 true 时，将构建配置设置为生产目标。所有构建都使用捆绑和有限的 tree-shaking。生产构建还执行有限的死代码消除。

--protractorConfig= protractorConfig: 指定 Protractor 配置文件。

--specs: 覆盖 Protractor 配置中的 spec 文件。

--suite=suite: 覆盖 Protractor 配置中的 suite。

--webdriverUpdate=true|false: 用于更新 webdriver。

默认值：true

ng generate 命令

ng generate 命令用于根据示意图生成和/或修改文件。

参数解释

<schematic >: 指定要生成的示意图或 collection:schematic。它可以接受以下子命令之一。

• appShell
• 应用程序
• class
• component
• directive
• enum
• guard
• interface
• 库
• 模块
• pipe
• service
• serviceWorker
• universal

示意图命令说明

appShell

用于生成应用外壳以运行应用的服务器端版本。

语法

应用程序

用于在工作区的 "projects" 子文件夹中创建一个新的基本应用定义。

语法

class

用于在给定或默认项目中创建一个新的通用类定义。

语法

component

用于在给定或默认项目中创建一个新的通用组件定义。

语法

directive

用于在给定或默认项目中创建一个新的通用指令定义。

语法

enum

用于为给定或默认项目创建一个新的通用枚举定义。

语法

enum

用于为给定或默认项目创建一个新的通用枚举定义。

语法

guard

用于在给定或默认项目中生成一个新的通用路由守卫定义。

语法

interface

用于在给定或默认项目中创建一个新的通用接口定义。

语法

库

用于在当前工作区中创建一个新的通用库项目。

语法

模块

用于在给定或默认项目中创建一个新的通用 NgModule 定义。

语法

pipe

用于在给定或默认项目中创建一个新的通用管道（pipe）定义。

语法

service

用于在给定或默认项目中创建一个新的通用服务定义。

语法

serviceWorker

用于将此示意图传递给 "run" 命令以创建 service worker。

语法

universal

此命令用于将此示意图传递给 "run" 命令以设置应用的服务器端渲染。

语法

选项

--defaults=true|false: 当为 true 时，它会禁用具有默认值的选项的交互式输入提示。

--dryRun=true|false: 当为 true 时，它会运行并报告活动，但不会写出结果。

默认值：false

别名：-d

--force=true|false: 当为 true 时，它会强制覆盖现有文件。

默认值：false

别名：-f

--help=true|false|json|JSON: 用于在控制台中显示帮助消息。

默认值：false

--interactive=true|false: 当为 false 时，它会禁用交互式输入提示。