{"id":17712,"library":"igniteui-cli","title":"Ignite UI CLI","description":"The `igniteui-cli` is a robust command-line interface tool engineered to accelerate the development of applications utilizing Ignite UI components. It empowers developers to rapidly scaffold new projects across popular frameworks such as Angular, React, and jQuery, and efficiently integrate individual components or complex scenario-based templates like dashboards into existing applications. The current stable version, 15.0.0, marks a significant major release, modernizing all Angular templates, embedding AI agent configurations into scaffolded projects, and introducing the Ignite UI CLI Model Context Protocol (MCP) Server to provide AI assistants with documentation, API reference lookup, and scaffolding capabilities. This version also deprecates and removes legacy wrapper-based project types, steering developers toward modern practices. The CLI undergoes frequent updates, particularly with major versions bringing substantial feature enhancements and breaking changes, distinguishing itself through comprehensive multi-framework support and a guided development experience.","status":"active","version":"15.0.0","language":"javascript","source_language":"en","source_url":"https://github.com/IgniteUI/igniteui-cli","tags":["javascript","CLI","Ignite UI","typescript"],"install":[{"cmd":"npm install igniteui-cli","lang":"bash","label":"npm"},{"cmd":"yarn add igniteui-cli","lang":"bash","label":"yarn"},{"cmd":"pnpm add igniteui-cli","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"This package is a command-line interface (CLI) tool designed for global installation and execution via the `ig` or `igniteui` commands, not for programmatic import within JavaScript/TypeScript files.","wrong":"import { igniteui } from 'igniteui-cli';\nconst igniteui = require('igniteui-cli');","symbol":"igniteui-cli (Global Tool)","correct":"npm install -g igniteui-cli\n# Then use 'ig' or 'igniteui' commands"},{"note":"The `ig new` command is used to scaffold new Ignite UI projects. It's crucial to specify the `--framework` and optionally `--type` and `--template` to get the desired project structure and components. Running `ig` without parameters starts an interactive guide.","wrong":"newProject(\"MyAngularApp\", ...);\nigniteui create \"MyAngularApp\"","symbol":"ig new (Scaffold Project)","correct":"ig new \"MyAngularApp\" --framework=angular --type=igx-ts --template=side-nav"},{"note":"The `ig add` command is used to add new components or templates to an *existing* Ignite UI project. Running `ig add` without parameters provides an interactive selection of available templates.","wrong":"addComponent('grid');\nigniteui addComponent grid","symbol":"ig add (Add Component)","correct":"ig add grid --name=MyDataGrid"}],"quickstart":{"code":"npm install -g igniteui-cli\n\n# Start an interactive guided experience\nig\n\n# Or create a new Ignite UI for Angular project directly\nig new \"MyDashboardApp\" --framework=angular --type=igx-ts --template=dashboard\n\n# Navigate into the new project directory\ncd MyDashboardApp\n\n# Add a new grid component to the project\nig add grid --name=EmployeesGrid\n\n# Build and run the application\nig start","lang":"bash","description":"This quickstart demonstrates the global installation of igniteui-cli, interactive project creation, direct project scaffolding for Angular, adding a new component, and finally building and running the generated application."},"warnings":[{"fix":"Migrate your project to use modern Angular (igx-ts) or React (igr-ts) templates, or recreate the project with a supported type. Refer to the official Ignite UI migration guides for details.","message":"Version 15.0.0 has removed support for legacy wrapper-based project types. Existing projects using these types must be migrated or recreated using modern templates.","severity":"breaking","affected_versions":">=15.0.0"},{"fix":"Always explicitly define `--framework`, `--type`, and `--theme` parameters when creating a new project to ensure you get the desired setup, e.g., `ig new \"MyProject\" --framework=angular --type=igx-ts --theme=material`.","message":"When using `ig new`, if `--framework`, `--type`, or `--theme` are not specified, the CLI will default to a jQuery framework and the first available project type/theme. This can lead to an unexpected project setup if not explicitly defined.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Check the `ig start` command documentation on the Ignite UI CLI Wiki for information on default ports and how to specify an alternative port if needed. You may also need to identify and terminate the process currently using the port.","message":"The `ig start` command attempts to open the scaffolded project in the default browser using a predefined port. If this port is already in use by another application, the project may not launch automatically or could fail to start.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-04-23T00:00:00.000Z","next_check":"2026-07-22T00:00:00.000Z","problems":[{"fix":"Run `npm install -g igniteui-cli` to install the CLI globally. If the issue persists, ensure your npm global bin directory is in your system's PATH.","cause":"The igniteui-cli package was not installed globally, or its executable path is not in your system's PATH environment variable.","error":"command not found: ig"},{"fix":"Either terminate the application using the port or consult the Ignite UI CLI documentation for the `ig start` command to learn how to specify a different port (e.g., `ig start --port 4201`).","cause":"The default port for your project type (e.g., Angular, React) is currently occupied by another application or a previous instance of your project.","error":"Error: Port X is already in use"},{"fix":"Update your command to use a modern project type, such as `igx-ts` for Angular or `igr-ts` for React. Refer to the latest documentation for available project types.","cause":"Attempting to create a project using a deprecated project type that was removed in version 15.0.0.","error":"Error: Project type 'legacy-wrapper' is no longer supported. Please choose a modern project template."}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}