5 lines
17 KiB
JSON
5 lines
17 KiB
JSON
{
|
|
"id": "cli/serve",
|
|
"title": "ng serve",
|
|
"contents": "\n<article>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular-cli/edit/master/packages/angular/cli/commands/serve.json?message=docs(...)%3A%20describe%20your%20change...\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular-cli/tree/v12.0.0-next.7/packages/angular/cli/commands/serve.json\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n \n\n\n<div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io/cli\", \"name\": \"CLI\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/cli/serve\", \"name\": \"serve\" } }\n ]\n }\n </script>\n <a href=\"cli\">CLI</a>\n</div>\n\n \n<header class=\"cli-header\">\n <h1 id=\"ng-serve\">ng serve<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"cli/serve#ng-serve\"><i class=\"material-icons\">link</i></a></h1>\n</header>\n\n\n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"cli-body\">\n \n <p>Builds and serves your app, rebuilding on file changes.</p>\n\n \n<code-example hidecopy=\"true\" class=\"no-box api-heading no-auto-link\">ng <span class=\"cli-name\">serve</span> <<var>project</var>> [<var>options</var>]</code-example>\n\n<code-example hidecopy=\"true\" class=\"no-box api-heading no-auto-link\">ng <span class=\"cli-name\">s</span> <<var>project</var>> [<var>options</var>]</code-example>\n\n\n\n \n\n \n\n<h2 class=\"no-anchor\" id=\"arguments\">Arguments</h2>\n<table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th width=\"15%\">Argument</th>\n <th width=\"40%\">Description</th>\n <th>Value Type</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"cli-option\">\n <td><code class=\"cli-option-syntax no-auto-link\"><<var>project</var>></code></td>\n <td>\n <p>The name of the project to build. Can be an application or a library.</p>\n\n \n </td>\n <td><code class=\"cli-option-syntax no-auto-link\">string</code></td>\n </tr>\n \n </tbody>\n</table>\n\n\n \n\n<h2 class=\"no-anchor\" id=\"options\">Options</h2>\n<table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th width=\"15%\">Option</th>\n <th width=\"40%\">Description</th>\n <th>Value Type</th>\n <th>Default Value</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--allowed-hosts</code>\n </td>\n <td>\n \n <p>List of hosts that are allowed to access the dev server.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">array</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--aot</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use the \"aot\" option in the browser builder instead.</p>\n\n \n \n <p>Build using Ahead of Time compilation.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--base-href</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use the \"baseHref\" option in the browser builder instead.</p>\n\n \n \n <p>Base url for the application being built.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--browser-target</code>\n </td>\n <td>\n \n <p>A browser builder target to serve in the format of <code>project:target[:configuration]</code>. You can also pass in more than one configuration name as a comma-separated list. Example: <code>project:target:production,staging</code>.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--common-chunk</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use the \"commonChunk\" option in the browser builder instead.</p>\n\n \n \n <p>Generate a seperate bundle containing code used across multiple bundles.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--configuration</code>\n </td>\n <td>\n \n <p>One or more named builder configurations as a comma-separated list as specified in the \"configurations\" section of angular.json.\nThe builder uses the named configurations to run the given target.\nFor more information, see <a href=\"https://angular.io/guide/workspace-config#alternate-build-configurations\">https://angular.io/guide/workspace-config#alternate-build-configurations</a>.\nSetting this explicitly overrides the \"--prod\" flag.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -c</p>\n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--deploy-url</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use the \"deployUrl\" option in the browser builder instead.</p>\n\n \n \n <p>URL where files will be deployed.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--disable-host-check</code>\n </td>\n <td>\n \n <p>Don't verify connected clients are part of allowed hosts.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--help</code>\n </td>\n <td>\n \n <p>Shows a help message for this command in the console.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">true|false|json|JSON</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--hmr</code>\n </td>\n <td>\n \n <p>Enable hot module replacement.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--hmr-warning</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> No longer has an effect.</p>\n\n \n \n <p>Show a warning when the --hmr option is enabled.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--host</code>\n </td>\n <td>\n \n <p>Host to listen on.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td><code class=\"no-auto-link\">localhost</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--live-reload</code>\n </td>\n <td>\n \n <p>Whether to reload the page on change, using live-reload.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--open</code>\n </td>\n <td>\n \n <p>Opens the url in default browser.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -o</p>\n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--optimization</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use the \"optimization\" option in the browser builder instead.</p>\n\n \n \n <p>Enables optimization of the build output. Including minification of scripts and styles, tree-shaking, dead-code elimination, tree-shaking and fonts inlining. For more information, see <a href=\"https://angular.io/guide/workspace-config#optimization-configuration\">https://angular.io/guide/workspace-config#optimization-configuration</a>.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--poll</code>\n </td>\n <td>\n \n <p>Enable and define the file watching poll time period in milliseconds.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">number</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--port</code>\n </td>\n <td>\n \n <p>Port to listen on.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">number</code></td>\n <td><code class=\"no-auto-link\">4200</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--prod</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use <code>--configuration production</code> instead.</p>\n\n \n \n <p>Shorthand for \"--configuration=production\".\nSet the build configuration to the production target.\nBy 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.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--progress</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use the \"progress\" option in the browser builder instead.</p>\n\n \n \n <p>Log progress to the console while building.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--proxy-config</code>\n </td>\n <td>\n \n <p>Proxy configuration file.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--public-host</code>\n </td>\n <td>\n \n <p>The URL that the browser client (or live-reload client, if enabled) should use to connect to the development server. Use for a complex dev server setup, such as one with reverse proxies.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--serve-path</code>\n </td>\n <td>\n \n <p>The pathname where the app will be served.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--serve-path-default-warning</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> No longer has an effect.</p>\n\n \n \n <p>Show a warning when deploy-url/base-href use unsupported serve path values.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--source-map</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use the \"sourceMap\" option in the browser builder instead.</p>\n\n \n \n <p>Output source maps for scripts and styles. For more information, see <a href=\"https://angular.io/guide/workspace-config#source-map-configuration\">https://angular.io/guide/workspace-config#source-map-configuration</a>.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--ssl</code>\n </td>\n <td>\n \n <p>Serve using HTTPS.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">false</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--ssl-cert</code>\n </td>\n <td>\n \n <p>SSL certificate to use for serving HTTPS.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--ssl-key</code>\n </td>\n <td>\n \n <p>SSL key to use for serving HTTPS.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link deprecated-api-item\">--vendor-chunk</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Use the \"vendorChunk\" option in the browser builder instead.</p>\n\n \n \n <p>Generate a seperate bundle containing only vendor libraries. This option should only used for development.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--verbose</code>\n </td>\n <td>\n \n <p>Adds more details to output logging.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--watch</code>\n </td>\n <td>\n \n <p>Rebuild on change.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">boolean</code></td>\n <td><code class=\"no-auto-link\">true</code></td>\n </tr>\n \n </tbody>\n</table>\n\n\n \n </div>\n</article>\n\n<!-- links to this doc:\n - cli\n - guide/aot-compiler\n - guide/what-is-angular\n - guide/workspace-config\n-->\n<!-- links from this doc:\n - cli\n - cli/serve#ng-serve\n - https://angular.io/guide/workspace-config#alternate-build-configurations\n - https://angular.io/guide/workspace-config#optimization-configuration\n - https://angular.io/guide/workspace-config#source-map-configuration\n - https://github.com/angular/angular-cli/edit/master/packages/angular/cli/commands/serve.json?message=docs(...)%3A%20describe%20your%20change...\n - https://github.com/angular/angular-cli/tree/v12.0.0-next.7/packages/angular/cli/commands/serve.json\n-->"
|
|
} |