Skip to content
Viktor Slavov edited this page Feb 13, 2019 · 12 revisions

Ignite UI CLI

Overview

The Ignite UI CLI is a tool to initialize, develop, scaffold and maintain applications in a wide variety of frameworks. It provides you with predefined templates for Ignite UI for JavaScript, Ignite UI for React and Ignite UI for Angular controls. Ignite UI CLI will give you a quick-start for your next project even if you are a newcomer to the Ignite UI products and to the target frameworks.
You can create projects and add Ignite UI for JavaScript controls in jQuery, Angular or React, executing the very same commands.
Using the Ignite UI CLI, you can also get advantage of the Ignite UI for Angular controls and you can implement them in your Angular 5 applications.

Getting Started

To install the Ignite UI CLI:

npm install -g igniteui-cli

To get a guided experience through the available options, simply run:

ig

If you prefer to provide the commands for generating an Ignite UI project, adding a new component, building and serving the project by yourself, you can use the following:

ig new <project name> --framework=<framework> --type=<proj-type> --theme=<theme>
cd <project name>
ig add <component/template> <component_name>
ig build
ig start

Projects of different frameworks use different ports to open your application. This is made in order to reduce the risk of unexpected issues when working with different projects. The table below shows what port each of the frameworks is using:

Framework Port
jQuery http://localhost:3000/
Angular Wrappers http://localhost:3001/
React http://localhost:3000/
React Wrappers http://localhost:3002/
Angular http://localhost:4200/

Available Commands