5 lines
16 KiB
JSON

{
"id": "cli/new",
"title": "ng new",
"contents": "\n<article>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular-cli/edit/master/packages/angular/cli/commands/new.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/new.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/new\", \"name\": \"new\" } }\n ]\n }\n </script>\n <a href=\"cli\">CLI</a>\n</div>\n\n \n<header class=\"cli-header\">\n <h1 id=\"ng-new\">ng new<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"cli/new#ng-new\"><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>Creates a new workspace and an initial Angular application.</p>\n\n \n<code-example hidecopy=\"true\" class=\"no-box api-heading no-auto-link\">ng <span class=\"cli-name\">new</span> &#x3C;<var>name</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\">n</span> &#x3C;<var>name</var>> [<var>options</var>]</code-example>\n\n\n\n \n <h2 class=\"no-anchor\" id=\"mode_edit---code----------description\">\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular-cli/edit/master/packages/angular/cli/commands/new.md?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/new.md\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n Description\n </h2>\n <p>Creates and initializes a new Angular application that is the default project for a new workspace.</p>\n<p>Provides interactive prompts for optional configuration, such as adding routing support.\nAll prompts can safely be allowed to default.</p>\n<ul>\n<li>\n<p>The new workspace folder is given the specified project name, and contains configuration files at the top level.</p>\n</li>\n<li>\n<p>By default, the files for a new initial application (with the same name as the workspace) are placed in the <code>src/</code> subfolder. Corresponding end-to-end tests are placed in the <code>e2e/</code> subfolder.</p>\n</li>\n<li>\n<p>The new application's configuration appears in the <code>projects</code> section of the <code>angular.json</code> workspace configuration file, under its project name.</p>\n</li>\n<li>\n<p>Subsequent applications that you generate in the workspace reside in the <code>projects/</code> subfolder.</p>\n</li>\n</ul>\n<p>If you plan to have multiple applications in the workspace, you can create an empty workspace by setting the <code>--createApplication</code> option to false.\nYou can then use <code>ng generate application</code> to create an initial application.\nThis allows a workspace name different from the initial app name, and ensures that all applications reside in the <code>/projects</code> subfolder, matching the structure of the configuration file.</p>\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\">&#x3C;<var>name</var>></code></td>\n <td>\n <p>The name of the new workspace and initial project.</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\">--collection</code>\n </td>\n <td>\n \n <p>A collection of schematics to use in generating the initial application.</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\">--commit</code>\n </td>\n <td>\n \n <p>Initial git repository commit information.</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\">--create-application</code>\n </td>\n <td>\n \n <p>Create a new initial application project in the 'src' folder of the new workspace. When false, creates an empty workspace with no initial application. You can then use the generate application command so that all applications are created in the projects folder.</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\">--defaults</code>\n </td>\n <td>\n \n <p>Disable interactive input prompts for options with a default.</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\">--directory</code>\n </td>\n <td>\n \n <p>The directory name to create the workspace in.</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\">--dry-run</code>\n </td>\n <td>\n \n <p>Run through and reports activity without writing out results.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -d</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\">--force</code>\n </td>\n <td>\n \n <p>Force overwriting of existing files.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -f</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\">--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\">--inline-style</code>\n </td>\n <td>\n \n <p>Include styles inline in the component TS file. By default, an external styles file is created and referenced in the component TypeScript file.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -s</p>\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\">--inline-template</code>\n </td>\n <td>\n \n <p>Include template inline in the component TS file. By default, an external template file is created and referenced in the component TypeScript file.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -t</p>\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\">--interactive</code>\n </td>\n <td>\n \n <p>Enable interactive input prompts.</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\">--legacy-browsers</code>\n </td>\n <td>\n \n \n <p><strong>Deprecated:</strong> Legacy browsers support is deprecated since version 12. For more information, see <a href=\"https://angular.io/guide/browser-support\">https://angular.io/guide/browser-support</a></p>\n\n \n \n <p>Add support for legacy browsers like Internet Explorer using differential loading.</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\">--minimal</code>\n </td>\n <td>\n \n <p>Create a workspace without any testing frameworks. (Use for learning purposes only.)</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\">--new-project-root</code>\n </td>\n <td>\n \n <p>The path where new projects will be created, relative to the new workspace root.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td><code class=\"no-auto-link\">projects</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--package-manager</code>\n </td>\n <td>\n \n <p>The package manager used to install dependencies.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">npm|yarn|pnpm|cnpm</code></td>\n <td></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--prefix</code>\n </td>\n <td>\n \n <p>The prefix to apply to generated selectors for the initial project.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -p</p>\n </td>\n <td><code class=\"no-auto-link\">string</code></td>\n <td><code class=\"no-auto-link\">app</code></td>\n </tr>\n \n <tr class=\"cli-option\">\n <td>\n <code class=\"cli-option-syntax no-auto-link\">--routing</code>\n </td>\n <td>\n \n <p>Generate a routing module for the initial project.</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\">--skip-git</code>\n </td>\n <td>\n \n <p>Do not initialize a git repository.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -g</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\">--skip-install</code>\n </td>\n <td>\n \n <p>Do not install dependency packages.</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\">--skip-tests</code>\n </td>\n <td>\n \n <p>Do not generate \"spec.ts\" test files for the new project.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -S</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\">--strict</code>\n </td>\n <td>\n \n <p>Creates a workspace with stricter type checking and stricter bundle budgets settings. This setting helps improve maintainability and catch bugs ahead of time. For more information, see <a href=\"https://angular.io/guide/strict-mode\">https://angular.io/guide/strict-mode</a></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\">--style</code>\n </td>\n <td>\n \n <p>The file extension or preprocessor to use for style files.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">css|scss|sass|less|styl</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>Add more details to output logging.</p>\n\n <p><span class=\"cli-aliases\">Aliases:</span> -v</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\">--view-encapsulation</code>\n </td>\n <td>\n \n <p>The view encapsulation strategy to use in the initial project.</p>\n\n \n </td>\n <td><code class=\"no-auto-link\">Emulated|None|ShadowDom</code></td>\n <td></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/glossary\n - guide/router-tutorial-toh\n - guide/visual-studio-2015\n - start/start-deployment\n-->\n<!-- links from this doc:\n - cli\n - cli/new#ng-new\n - https://angular.io/guide/browser-support\n - https://angular.io/guide/strict-mode\n - https://github.com/angular/angular-cli/edit/master/packages/angular/cli/commands/new.json?message=docs(...)%3A%20describe%20your%20change...\n - https://github.com/angular/angular-cli/edit/master/packages/angular/cli/commands/new.md?message=docs%3A%20describe%20your%20change...\n - https://github.com/angular/angular-cli/tree/v12.0.0-next.7/packages/angular/cli/commands/new.json\n - https://github.com/angular/angular-cli/tree/v12.0.0-next.7/packages/angular/cli/commands/new.md\n-->"
}