In this post, we’ll learn about Angular CLI and we’ll see how to use it to initialize a new Angular project.
What is Angular CLI?
Angular CLI is the official tool for initializing and working with Angular projects. It saves you from the hassle of complex configurations and build tools like TypeScript, Webpack, and so on.
After installing Angular CLI, you’ll need to run one command to generate a project and another to serve it using a local development server to play with your application.
Like most modern frontend tools these days, Angular CLI is built on top of Node.js.
Check out the MEAN stack — it’s an architecture that includes MongoDB, Express (a web server and REST API framework built on top of Node.js) and Angular. You can read this article if you’d like a step by step tutorial to get started.
In this case, Node.js is used to build the back end part of your app and can be replaced with any server-side technology that you want such as PHP, Ruby, or Python. But Angular doesn’t depend on Node.js except for its CLI tool and for installing packages from npm.
NPM stands for Node Package Manager. It’s a registry for hosting Node packages. In recent years it’s also been used to publish front end packages and libraries like Angular, React, Vue.js and even Bootstrap.
Note: you can download our Angular Book: Build your first web apps with Angular for free.
Installing Angular CLI
First, you need to have Node and npm installed on your development machine. There are many ways to do that, such as:
- using NVM (Node Version Manager) for installing and working with multiple versions of node in your system
- using the official package manager of your operating system
- installing it from the official website.
Let’s keep it simple and use the official website. Simply visit the download page and grab the binaries for Windows, then follow the setup wizard.
You can make sure Node is installed on your system by running the following command in a command prompt which should display the installed version of Node:
$ node -v
Next, run the following command to install Angular CLI:
$ npm install @angular/cli
At the time of this writing, Angular 8.3 will be installed.
If you want to install Angular 9, simply add the
next tag as follows:
$ npm install @angular/cli@next
After the command finishes successfully, you should have Angular CLI installed.
A Quick Guide for Angular CLI
After installing Angular CLI, you can run many commands. Let’s start by checking the version of the installed CLI:
$ ng version
A second command that you might need to run is the
help command for getting a complete usage help:
$ ng help
The CLI provides the following commands:
add: Adds support for an external library to your project.
build (b): Compiles an Angular app into an output directory named
dist/ at the given output path. Must be executed from within a workspace directory.
config: Retrieves or sets Angular configuration values.
doc (d): Opens the official Angular documentation (angular.io) in a browser, and searches for a given keyword.
e2e (e): Builds and serves an Angular app, then runs end-to-end tests using Protractor.
generate (g): Generates and/or modifies files based on a schematic.
help: Lists available commands and their short descriptions.
lint (l): Runs linting tools on Angular app code in a given project folder.
new (n): Creates a new workspace and an initial Angular app.
run: Runs a custom target defined in your project.
serve (s): Builds and serves your app, rebuilding on file changes.
test (t): Runs unit tests in a project.
update: Updates your application and its dependencies. See https://update.angular.io/
version (v): Outputs Angular CLI version.
xi18n: Extracts i18n messages from source code.
Generating a Project
You can use Angular CLI to quickly generate your Angular project by running the following command in your command-line interface:
$ ng new frontend
Note: frontend is the name of the project. You can, of course, choose any valid name for your project. Since we’ll create a full-stack application I’m using frontend as a name for the front-end application.
As mentioned earlier, the CLI will ask you Would you like to add Angular routing? and you can answer by entering
y (Yes) or
n (No), which is the default option. It will also ask you about the stylesheet format you want to use (such as CSS). Choose your options and hit
Enter to continue.
After that, you’ll have your project created with a directory structure and a bunch of configurations and code files. It’ll be mostly in TypeScript and JSON formats. Let’s see the role of each file:
/e2e/: contains end-to-end (simulating user behavior) tests of the website
/node_modules/: All 3rd party libraries are installed to this folder using
/src/: contains the source code of the application. Most work will be done here
/app/: contains modules and components
/assets/: contains static assets like images, icons and styles
/environments/: contains environment (production and development) specific configuration files
browserslist: needed by autoprefixer for CSS support
favicon.ico: the favicon
index.html: the main HTML file
karma.conf.js: the configuration file for Karma (a testing tool)
main.ts: the main starting file from where the AppModule is bootstrapped
polyfills.ts: polyfills needed by Angular
styles.css: the global stylesheet file for the project
test.ts: this is a configuration file for Karma
tsconfig.*.json: the configuration files for TypeScript
angular.json: contains the configurations for CLI
package.json: contains the basic information of the project (name, description and dependencies)
README.md: a markdown file that contains a description of the project
tsconfig.json: the configuration file for TypeScript
tslint.json: the configuration file for TSlint (a static analysis tool)
Serving your Project
Angular CLI provides a complete tool-chain for developing front-end apps on your local machine. As such, you don’t need to install a local server to serve your project — you can simply, use the
ng serve command from your terminal to serve your project locally.
First, navigate inside your project’s folder and run the following commands:
$ cd frontend
$ ng serve
You can now navigate to the http://localhost:4200/ address to start playing with your front end application. The page will automatically live-reload if you change any source file.
Generating Angular Artifacts
Angular CLI provides an
ng generate command which helps developers generate basic Angular artifacts such as modules, components, directives, pipes, and services:
$ ng generate component my-component
my-component is the name of the component. The Angular CLI will automatically add a reference to
pipes in the
If you want to add your component, directive or pipe to another module (other than the main application module,
app.module.ts), you can simply prefix the name of the component with the module name and a slash :
$ ng g component my-module/my-component
my-module is the name of an existing module.
In this post, we’ve seen how to install Angular CLI on our development machine and we used it to initialize a new Angular project from scratch.
We have also seen various commands that you can use throughout the development of your project for generating Angular artifacts such as modules, components, and services.