Ignite UI CLI

    Ignite UI CLI is a command line tool to create and scaffold applications for a variety of frameworks. Ignite UI CLI offers project templates pre-configured for Ignite UI for Angular to 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 give a boost to productivity.

    Getting Started

    Let's start by opening a preferred terminal and installing the Ignite UI CLI:

    npm install -g igniteui-cli

    Once the Ignite UI CLI is installed, there are two possible options/modes to start the tool - guided experience and using specific commands.

    Using guided experience

    The shortest and easiest way to bootstrap an application is to use the Ignite UI CLI guided step by step mode, 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

    We can always use the Ignite UI CLI commands for generating an Ignite UI project, adding a new component or building and serving the project by ourselves. For that purpose, we can use the following commands:

    ig new <project name> --framework=angular --type=igx-ts 
cd <project name>
ig add <component/template> <component_name>
ig start
    • The full list of available component/template values is here, you can run ig list command in your project directory to list all the available templates.
    • Both the project name and the component_name are custom values, provided by the developer. Here is an example of creating a new Ignite UI for Angular project with an igxGrid control:
    ig new newAngularProject --framework=angular --type=igx-ts
cd newAngularProject
ig add grid newGrid
ig start

    After executing those simple commands, your new project will be built and served. It will automatically open in your default browser and you will be able to inspect your grid control and to make changes to the project.

    Available commands

    A full list of the available Ignite UI CLI commands as well as details on the usage (like passing flags, etc.), can be found at the Ignite UI CLI wiki.

    Command Alias Description
    ig new Create a new Angular, jQuery or React application. The application will be configured to use either Ignite UI for Angular, or Ignite UI for JavaScript controls.
    ig add Adds a template by its ID and providing a name to an existing project
    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