Angular CLI

CLI tool for Angular

README

<!--
  BEFORE UPDATING THIS FILE, READ THIS.

  This file is automatically generated during release. It is important for you to not update
  README directly.

  - If you need to change the content, update scripts/templates/readme.ejs
  - If you need to add/remove a package or a link, update the .monorepo.json file instead.

  Any changes to README.md directly will result in a failure on CI.
-->

Angular CLI - The CLI tool for Angular.


Angular CLI logo

The Angular CLI is a command-line interface tool that you use to initialize, develop, scaffold,
and maintain Angular applications directly from a command shell.

cli.angular.io

Contributing Guidelines

  ·
Submit an Issue
  ·
Blog

CI status   Discord conversation



Documentation


Get started with Angular CLI, learn the fundamentals and explore advanced topics on our documentation website.

- [Getting started][quickstart]
- [CLI][cli]
- [Workspace and project file structure][filestructure]
- [Workspace configuration][workspaceconfig]
- [Schematics][schematics]

Development Setup



Prerequisites


- Install [Node.js] which includes [Node Package Manager][npm]

Setting Up a Project


Install the Angular CLI globally:

  1. ```
  2. npm install -g @angular/cli
  3. ```

Create workspace:

  1. ```
  2. ng new [PROJECT NAME]
  3. ```

Run the application:

  1. ```
  2. cd [PROJECT NAME]
  3. ng serve
  4. ```

Angular is cross-platform, fast, scalable, has incredible tooling, and is loved by millions.

Quickstart


[Get started in 5 minutes][quickstart].

Ecosystem


angular ecosystem logos


- [Angular Framework][aio]
- [Angular Material][angularmaterial]

Changelog


[Learn about the latest improvements][changelog].

Upgrading


Check out our upgrade guide to find out the best way to upgrade your project.

Contributing


Contributing Guidelines


Read through our [contributing guidelines][contributing] to learn about our submission process, coding rules and more.

Want to Help?


Want to report a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing][contributing] and then check out one of our issues labeled as [help wanted](https://github.com/angular/angular-cli/labels/help%20wanted) or [good first issue](https://github.com/angular/angular-cli/labels/good%20first%20issue).

Code of Conduct


Help us keep Angular open and inclusive. Please read and follow our [Code of Conduct][codeofconduct].

Developer Guide


Read through our [developer guide][developer] to learn about how to build and test the Angular CLI locally.


Community


Join the conversation and help the community.

- [Twitter][twitter]
- [Discord][discord]
- [Gitter][gitter]
- [YouTube][youtube]
- [StackOverflow][stackoverflow]
- Find a Local [Meetup][meetup]

Packages


This is a monorepo which contains many tools and packages:



Tools


ProjectPackageVersionLinks
|---|---|---|---|
[`@angular/cli`](https://npmjs.com/package/@angular/cli)[![latest](https://img.shields.io/npm/v/%40angular%2Fcli/latest.svg)](https://npmjs.com/package/@angular/cli)[![README](https://img.shields.io/badge/README--green.svg)](/packages/angular/cli/README.md)
[`@angular-devkit/architect-cli`](https://npmjs.com/package/@angular-devkit/architect-cli)[![latest](https://img.shields.io/npm/v/%40angular-devkit%2Farchitect-cli/latest.svg)](https://npmjs.com/package/@angular-devkit/architect-cli)[![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-architect-cli-builds)
[`@angular-devkit/schematics-cli`](https://npmjs.com/package/@angular-devkit/schematics-cli)[![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fschematics-cli/latest.svg)](https://npmjs.com/package/@angular-devkit/schematics-cli)[![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-schematics-cli-builds)


Packages



ProjectPackageVersionLinks
|---|---|---|---|
[`@angular-devkit/architect`](https://npmjs.com/package/@angular-devkit/architect)[![latest](https://img.shields.io/npm/v/%40angular-devkit%2Farchitect/latest.svg)](https://npmjs.com/package/@angular-devkit/architect)[![README](https://img.shields.io/badge/README--green.svg)](/packages/angular_devkit/architect/README.md)
[`@angular-devkit/build-angular`](https://npmjs.com/package/@angular-devkit/build-angular)[![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fbuild-angular/latest.svg)](https://npmjs.com/package/@angular-devkit/build-angular)[![README](https://img.shields.io/badge/README--green.svg)](/packages/angular_devkit/build_angular/README.md)
[`@angular-devkit/build-webpack`](https://npmjs.com/package/@angular-devkit/build-webpack)[![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fbuild-webpack/latest.svg)](https://npmjs.com/package/@angular-devkit/build-webpack)[![README](https://img.shields.io/badge/README--green.svg)](/packages/angular_devkit/build_webpack/README.md)
[`@angular-devkit/core`](https://npmjs.com/package/@angular-devkit/core)[![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fcore/latest.svg)](https://npmjs.com/package/@angular-devkit/core)[![README](https://img.shields.io/badge/README--green.svg)](/packages/angular_devkit/core/README.md)
[`@angular-devkit/schematics`](https://npmjs.com/package/@angular-devkit/schematics)[![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fschematics/latest.svg)](https://npmjs.com/package/@angular-devkit/schematics)[![README](https://img.shields.io/badge/README--green.svg)](/packages/angular_devkit/schematics/README.md)

Misc


ProjectPackageVersionLinks
|---|---|---|---|
[`@angular/create`](https://npmjs.com/package/@angular/create)[![latest](https://img.shields.io/npm/v/%40angular%2Fcreate/latest.svg)](https://npmjs.com/package/@angular/create)[![README](https://img.shields.io/badge/README--green.svg)](/packages/angular/create/README.md)
[`@ngtools/webpack`](https://npmjs.com/package/@ngtools/webpack)[![latest](https://img.shields.io/npm/v/%40ngtools%2Fwebpack/latest.svg)](https://npmjs.com/package/@ngtools/webpack)[![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/ngtools-webpack-builds)

Schematics


ProjectPackageVersionLinks
|---|---|---|---|
[`@angular/pwa`](https://npmjs.com/package/@angular/pwa)[![latest](https://img.shields.io/npm/v/%40angular%2Fpwa/latest.svg)](https://npmjs.com/package/@angular/pwa)[![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-pwa-builds)
[`@schematics/angular`](https://npmjs.com/package/@schematics/angular)[![latest](https://img.shields.io/npm/v/%40schematics%2Fangular/latest.svg)](https://npmjs.com/package/@schematics/angular)[![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/schematics-angular-builds)



Love Angular CLI? Give our repo a star :star: :arrow_up:.

[contributing]: CONTRIBUTING.md
[developer]: docs/DEVELOPER.md
[quickstart]: https://angular.io/start
[changelog]: CHANGELOG.md
[documentation]: https://angular.io/docs
[angularmaterial]: https://material.angular.io/
[cli]: https://cli.angular.io/
[aio]: https://angular.io/
[workspaceconfig]: https://angular.io/guide/workspace-config
[schematics]: https://angular.io/guide/schematics
[filestructure]: https://angular.io/guide/file-structure
[node.js]: https://nodejs.org/
[npm]: https://www.npmjs.com/get-npm
[codeofconduct]: https://github.com/angular/angular/blob/main/CODE_OF_CONDUCT.md
[twitter]: https://www.twitter.com/angular
[discord]: https://discord.gg/angular
[gitter]: https://gitter.im/angular/angular-cli
[stackoverflow]: https://stackoverflow.com/questions/tagged/angular-cli
[youtube]: https://youtube.com/angular
[meetup]: https://www.meetup.com/find/?keywords=angular