angular/aio/content/cli/help/serve.json

{
  "name": "serve",
  "command": "ng serve [project]",
  "shortDescription": "Builds and serves your application, rebuilding on file changes.",
  "aliases": [
    "dev",
    "s"
  ],
  "deprecated": false,
  "options": [
    {
      "name": "allowed-hosts",
      "type": "array",
      "description": "List of hosts that are allowed to access the dev server. This option has no effect when using the 'application' or other esbuild-based builders."
    },
    {
      "name": "browser-target",
      "type": "string",
      "deprecated": "Use 'buildTarget' instead.",
      "description": "A browser builder target to serve in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`."
    },
    {
      "name": "build-target",
      "type": "string",
      "description": "A build builder target to serve in the format of `project:target[:configuration]`. You can also pass in more than one configuration name as a comma-separated list. Example: `project:target:production,staging`."
    },
    {
      "name": "configuration",
      "type": "string",
      "aliases": [
        "c"
      ],
      "description": "One or more named builder configurations as a comma-separated list as specified in the \"configurations\" section in angular.json.\nThe builder uses the named configurations to run the given target.\nFor more information, see https://angular.io/guide/workspace-config#alternate-build-configurations."
    },
    {
      "name": "disable-host-check",
      "type": "boolean",
      "default": false,
      "description": "Don't verify connected clients are part of allowed hosts. This option has no effect when using the 'application' or other esbuild-based builders."
    },
    {
      "name": "force-esbuild",
      "type": "boolean",
      "default": false,
      "description": "Force the development server to use the 'browser-esbuild' builder when building. This is a developer preview option for the esbuild-based build system."
    },
    {
      "name": "help",
      "type": "boolean",
      "description": "Shows a help message for this command in the console."
    },
    {
      "name": "hmr",
      "type": "boolean",
      "default": false,
      "description": "Enable hot module replacement."
    },
    {
      "name": "host",
      "type": "string",
      "default": "localhost",
      "description": "Host to listen on."
    },
    {
      "name": "live-reload",
      "type": "boolean",
      "default": true,
      "description": "Whether to reload the page on change, using live-reload."
    },
    {
      "name": "open",
      "type": "boolean",
      "aliases": [
        "o"
      ],
      "default": false,
      "description": "Opens the url in default browser."
    },
    {
      "name": "poll",
      "type": "number",
      "description": "Enable and define the file watching poll time period in milliseconds."
    },
    {
      "name": "port",
      "type": "number",
      "default": 4200,
      "description": "Port to listen on."
    },
    {
      "name": "prebundle",
      "type": "boolean",
      "description": "Enable and control the Vite-based development server's prebundling capabilities. To enable prebundling, the Angular CLI cache must also be enabled. This option has no effect when using the 'browser' or other Webpack-based builders."
    },
    {
      "name": "project",
      "type": "string",
      "description": "The name of the project to build. Can be an application or a library.",
      "positional": 0
    },
    {
      "name": "proxy-config",
      "type": "string",
      "description": "Proxy configuration file. For more information, see https://angular.io/guide/build#proxying-to-a-backend-server."
    },
    {
      "name": "public-host",
      "type": "string",
      "description": "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. This option has no effect when using the 'application' or other esbuild-based builders."
    },
    {
      "name": "serve-path",
      "type": "string",
      "description": "The pathname where the application will be served."
    },
    {
      "name": "ssl",
      "type": "boolean",
      "default": false,
      "description": "Serve using HTTPS."
    },
    {
      "name": "ssl-cert",
      "type": "string",
      "description": "SSL certificate to use for serving HTTPS."
    },
    {
      "name": "ssl-key",
      "type": "string",
      "description": "SSL key to use for serving HTTPS."
    },
    {
      "name": "verbose",
      "type": "boolean",
      "description": "Adds more details to output logging."
    },
    {
      "name": "watch",
      "type": "boolean",
      "default": true,
      "description": "Rebuild on change."
    }
  ]
}