Repository: angular/angular-cli

Stars: 27040

README.md Copy Chapter

<!--
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.
-->

<h1 style="text-align: center">Angular CLI - The CLI tool for Angular.</h1>

<p style="text-align: center">
<br>
<img src="/docs/images/angular-cli-logo.png" alt="Angular CLI logo" width="100px" height="108px"/>
<br><br>
<em>The Angular CLI is a command-line interface tool that you use to initialize, develop, scaffold,
<br>and maintain Angular applications directly from a command shell.</em>
<br>
</p>

<p style="text-align: center">
<a href="https://angular.dev/tools/cli"><strong>angular.dev/tools/cli</strong></a>
<br>
</p>

<p style="text-align: center">
<a href="CONTRIBUTING.md">Contributing Guidelines</a>
·
<a href="https://github.com/angular/angular-cli/issues">Submit an Issue</a>
·
<a href="https://blog.angular.dev">Blog</a>
<br>
<br>
</p>

<hr>

Documentation Copy Chapter

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 Copy Chapter

Prerequisites Copy Section

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

Setting Up a Project Copy Section

Install the Angular CLI globally:

npm install -g @angular/cli

Create workspace:

ng new [PROJECT NAME]

Run the application:

cd [PROJECT NAME]
ng serve

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

Quickstart Copy Chapter

[Get started in 5 minutes][quickstart].

Ecosystem Copy Chapter

<p>
<img src="/docs/images/angular-ecosystem-logos.png" alt="angular ecosystem logos" width="500px" height="auto">
</p>

- [Angular Framework][adev]
- [Angular Material][angularmaterial]

Changelog Copy Chapter

[Learn about the latest improvements][changelog].

Upgrading Copy Chapter

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

Contributing Copy Chapter

Contributing Guidelines Copy Section

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

Want to Help? Copy Section

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 <kbd>help wanted</kbd> or <kbd>good first issue</kbd>.

Code of Conduct Copy Section

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

Developer Guide Copy Section

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

Community Copy Chapter

Join the conversation and help the community.

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

Packages Copy Chapter

This is a monorepo which contains many tools and packages:

Tools Copy Section

| Project | Package | Version | Links |
|---|---|---|---|
Angular Build System | @angular/build |  |  
Angular CLI | @angular/cli |  |  
Schematics CLI | @angular-devkit/schematics-cli |  | 

Packages Copy Section

| Project | Package | Version | Links |
|---|---|---|---|
Angular SSR | @angular/ssr |  |  
Architect | @angular-devkit/architect |  |  
Build Angular | @angular-devkit/build-angular |  |  
Build Webpack | @angular-devkit/build-webpack |  |  
Core | @angular-devkit/core |  |  
Schematics | @angular-devkit/schematics |  |  

#### Misc

| Project | Package | Version | Links |
|---|---|---|---|
Angular Create | @angular/create |  | 
Webpack Angular Plugin | @ngtools/webpack |  | 

#### Schematics

| Project | Package | Version | Links |
|---|---|---|---|
Angular PWA Schematics | @angular/pwa |  | 
Angular Schematics | @schematics/angular |  | 

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

[contributing]: CONTRIBUTING.md
[developer]: docs/DEVELOPER.md
[quickstart]: https://angular.dev/tutorials/learn-angular
[changelog]: CHANGELOG.md
[documentation]: https://angular.dev/overview
[angularmaterial]: https://material.angular.dev/
[cli]: https://angular.dev/tools/cli
[adev]: https://angular.dev/
[workspaceconfig]: https://angular.dev/reference/configs/workspace-config
[schematics]: https://angular.dev/tools/cli/schematics
[filestructure]: https://angular.dev/reference/configs/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.x.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