Ignite UI CLI

Ignite UI CLI is a command-line tool for creating and scaffolding applications for a variety of frameworks. It provides project templates pre-configured for Ignite UI for Angular that helps you get your next app off the ground in record time. A selection of views with Ignite UI for Angular components that can be further added to projects provides a substantial productivity boost for developers.

Getting Started

Install Ignite UI CLI using the npm package manager:

npm install -g igniteui-cli 

Once the installation process is finished, you can start the tool using either guided experience or specific commands.

Using guided experience

The shortest and easiest way to bootstrap an application is to use the Ignite UI CLI Step-by-Step Guide, which creates a configured app that can be up and running with the ease of a single command.

ig

Building Your First Ignite UI CLI App

Using commands

To create new project, add a component template and build it use the following Ignite UI CLI commands:

ig new <project name> --framework=angular --type=igx-ts 
cd <project name>
ig add <component/template> <component_name>
ig start 

To execute the above commands, you should replace the project name and component_name placeholders with an actual value. After running these commands, your new project will be built, served and automatically opened in your default browser.

Commands

Create new project

To create an application that is configured to use the Ignite UI for Angular controls, you need to provide angular as framework and igx-ts as your project type argument:

ig new newAngularProject --framework=angular --type=igx-ts --template=side-nav

The new application is created in a directory with the same name (newAngularProject). Ignite UI CLI also provides several project templates from which you can choose when creating an Ignite UI for Angular application:

template id template description
empty-project Project structure with routing and a home page
side-nav Project structure with side navigation drawer
side-nav-auth Side navigation project extended with user authentication module.
Angular Authentication Project Template topic covers the project template in detail.

Additionally, you can specify arguments to control the theme or skip packages install:

name

name (alias: -n)

The name of the application. The application is created inside a directory with the same name.

framework

--framework (alias: -f) default value: "jquery"

Framework to setup project for. The supported frameworks are jQuery, Angular and React.

type

--type (alias: -t)

The available project types depend on the selected framework.

theme

--theme (alias: -th)

Project theme (depends on project type).

skip-git

--skip-git (alias: --sg)

When this option is used, the automatic repository initialization with Git will be skipped. If the option is omitted, then the global skipGit configuration property is used.

skip-install (v4.0.0)

--skip-install (alias: --si)

Since v4.0.0 the ig new command will install package dependencies when the project is created. Passing this flag will skip the initial installation.

template (v3.0.0)

--template

Use this option if there are different project templates for a specific framework type. Currently this option is available only for Ignite UI for Angular igx-ts project types.

Add template

ig add [template] [name] adds a template by ID from the available templates with the name provided.

cd newAngularProject
ig add grid newGrid

The add command is supported only on existing project created with the Ignite UI CLI. To get a list of all the available templates you can also execute the ig list command in your project directory.

Additionally, you can specify arguments to control the theme or skip packages install:

module (v2.0.0)

--module (alias: -m)

note: module argument is applicable only in Angular projects.

Path to the module.ts file, relative to the /src/app/ folder, for the module where the new component should be registered:

ig add grid newCombo --name=myModule/myModule.module.ts
skip-route (v3.2.0)

--skip-route (alias: -srk)

Don't auto-generate am app navigation route for the new component

Run the application

Executing the ig start command will build the application, start a web server and open it in your default browser.

ig start

Available Commands

A full list of the available Ignite UI CLI commands and their usage (like passing flags, etc.), can be found at the Ignite UI CLI wiki pages:

Command Alias Description
ig start Builds the application, starts a web server and opens the application in the default browser.
ig build Builds the application into an output directory
ig generate g Generates a new custom template for supported frameworks and project types
ig help -h Lists the available commands and provides a brief description of what they do.
ig config Performs read and write operation on the Ignite UI CLI configuration settings.
ig doc Searches the Infragistics knowledge base for information about a given search term
ig list l Lists all templates for the specified framework and type. When you run the command within a project folder it will list all templates for the project's framework and type, even if you provide different ones.
ig test Executes the tests for the current project.
ig version -v Shows Ignite UI CLI version installed locally, or globally if local is missing