Skip to content
Back to search

igniteui-cli

Ignite UI Command-Line Interface by Infragistics

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/IgniteUI/igniteui-cli with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/IgniteUI/igniteui-cli'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/igniteui--igniteui-cli/badge.svg)](/listings/igniteui--igniteui-cli)

HTML

<a href="/listings/igniteui--igniteui-cli"><img src="/api/listings/igniteui--igniteui-cli/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Install the npm package as a global module:

npm install -g igniteui-cli

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 370 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. ## Ignite UI CLI
  2. <!-- Badges section here. -->
  3. ![Node.js CI](https://github.com/IgniteUI/igniteui-cli/workflows/Node.js%20CI/badge.svg)
  4. [![Coverage Status](https://coveralls.io/repos/github/IgniteUI/igniteui-cli/badge.svg)](https://coveralls.io/github/IgniteUI/igniteui-cli)
  5. [![npm version](https://badge.fury.io/js/igniteui-cli.svg)](https://badge.fury.io/js/igniteui-cli)
  6. [![Discord](https://img.shields.io/discord/836634487483269200?logo=discord&logoColor=ffffff)](https://discord.gg/39MjrTRqds)
  7. Quickly create projects, including [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-angular) and [Ignite UI for Web Components](https://www.infragistics.com/products/ignite-ui-web-components), for a variety of frameworks.
  8. ## Overview
  9. ### Features:
  10. - Create project structure
  11. - Add views with Ignite UI components (e.g. Combo, Grid or Chart)
  12. - Add scenario based templates with multiple components (e.g. a dashboard)
  13. - Build and install npm packages
  14. - Select a theme, support for custom themes coming soon
  15. - Step by step guide
  16. ### Supported frameworks
  17. * Angular
  18. * React
  19. * Web Components
  20. * Blazor
  21. * jQuery
  22. ### Prerequisites
  23. The repository houses multiple packages and orchestrates building and publishing them with [lerna](https://github.com/lerna/lerna) and [npm workspaces](https://docs.npmjs.com/cli/using-npm/workspaces).
  24. To build the repository locally you only need Node.js (CI uses 24.x and 26.x) and the npm that ships with it. Install the dependencies from the repository root with `npm ci`, which installs exactly what `package-lock.json` records. Use `npm install` only when you are changing dependencies, since it can rewrite the lockfile.
  25. ### Packages
  26. This monorepo contains several packages that combine into the `igniteui-cli`:
  27. | Package | Description | Location |
  28. |-----|-----|-----|
  29. | [@igniteui/cli-core](https://www.npmjs.com/package/@igniteui/cli-core) | Contains the core functionality of the cli tool | [packages/core](./packages/core) |
  30. | [@igniteui/angular-templates](https://www.npmjs.com/package/@igniteui/angular-templates) | Contains the template definitions for Angular components | [packages/igx-templates](./packages/igx-templates) |
  31. | [@igniteui/angular-schematics](https://www.npmjs.com/package/@igniteui/angular-schematics) | IgniteUI CLI implementation to be used with Angular CLI's schematics engine | [packages/ng-schematics](./packages/ng-schematics) |
  32. | [igniteui-cli](https://www.npmjs.com/package/igniteui-cli) | Standalone IgniteUI CLI tool for React, Blazor, Angular, jQuery and Web Components | [packages/cli](./packages/cli) |
  33. | [@igniteui/mcp-server](https://www.npmjs.com/package/@igniteui/mcp-server) | MCP server providing AI assistants with Ignite UI documentation and API reference | [packages/igniteui-mcp/igniteui-doc-mcp](./packages/igniteui-mcp/igniteui-doc-mcp) |
  34. ## Table of Contents
  35. * [Installation](#installation)
  36. * [Usage](#usage)
  37. * [Step by step](#step-by-step)
  38. * [List available commands](#list-the-available-commands)
  39. * [Generating Projects and adding components](#generating-projects-and-adding-components)
  40. * [Generate Ignite UI for Angular project](#generate-ignite-ui-for-angular-project)
  41. * [Generate Ignite UI for React project](#generate-ignite-ui-for-react-project)
  42. * [Adding components](#adding-components)
  43. * [Build and run](#build-and-run)
  44. * [Search the docs](#search-the-docs)
  45. * [Check your setup](#check-your-setup)
  46. * [Configure AI Tooling](#configure-ai-tooling)
  47. * [MCP Server](#mcp-server)
  48. * [Using with AI Assistants](#using-with-ai-assistants)
  49. * [Testing with MCP Inspector](#testing-with-mcp-inspector)
  50. * [Schematics](#schematics)
  51. * [Schematic Definitions](#schematic-definitions)
  52. * [Contribution](#contribution)
  53. ## Installation
  54. Install the npm package as a global module:
  55. ```bash
  56. npm install -g igniteui-cli
  57. ```
  58. ## Usage
  59. The main entry point is `igniteui` and is also aliased as `ig`. Both can be used interchangeably to call available commands. Check out our [Wiki documentation](https://github.com/IgniteUI/igniteui-cli/wiki) for more details.
  60. ### Step by step
  61. To get a guided experience through the available options, simply run:
  62. ```bash
  63. ig
  64. ```
  65. ![](assets/igniteui-cli.gif)
  66. Upon creation, project will be automatically loaded in the default browser.
  67. **NOTE**: If that doesn't happen the port may be already in use. Ports vary for different project types, see the description for the [`ig start`](https://github.com/IgniteUI/igniteui-cli/wiki/Start) command for details on default ports.
  68. ### List the available commands.
  69. ```bash
  70. ig help
  71. ```
  72. ### Generating projects and adding components
  73. Create a new project passing name, framework and style theme.
  74. ```bash
  75. ig new <project name> --framework=<framework> --type=<proj-type> --theme=<theme>
  76. ```
  77. This will create the project and will install the needed dependencies.
  78. Parameters besides name are optional. Framework defaults to "angular", project type defaults to the first available in the framework and theme to the first available for the project. For more information visit [ig new](https://github.com/IgniteUI/igniteui-cli/wiki/New) Wiki page.
  79. #### Generate Ignite UI for Angular project
  80. To create a new project with Ignite UI for Angular use [ig new](https://github.com/IgniteUI/igniteui-cli/wiki/New#creating-ignite-ui-for-angular-applications) by specifying `angular` as framework, and optionally `igx-ts` as project type and selecting one of the [project templates](https://github.com/IgniteUI/igniteui-cli/wiki/New#arguments):
  81. ```bash
  82. ig new "IG Project" --framework=angular --type=igx-ts --template=side-nav
  83. ```
  84. The project is created with the Angular CLI (`ng new`, then `ng add igniteui-angular`), so this needs network access and always installs the project's packages: `--skip-install` has no effect for Angular projects.
  85. #### Generate Ignite UI for React project
  86. To create a new project with Ignite UI for React use [ig new](https://github.com/IgniteUI/igniteui-cli/wiki/New#creating-ignite-ui-for-react-applications-v400) by specifying `react` as framework and `igr-ts` as project type:
  87. ```bash
  88. ig new "IG Project" --framework=react --type=igr-ts
  89. ```
  90. #### Generate Ignite UI for Web Components project
  91. To create a new project with Ignite UI for Web Components use [ig new](https://github.com/IgniteUI/igniteui-cli/wiki/New#creating-ignite-ui-for-web-components-applications) by specifying `webcomponents` as framework:
  92. ```bash
  93. ig new "IG Project" --framework=webcomponents
  94. ```
  95. #### Adding components
  96. Once you have created a project, at any point you can add additional component templates using [ig add](https://github.com/IgniteUI/igniteui-cli/wiki/Add). Running the command without parameters will guide you through the available templates:
  97. ```bash
  98. ig add
  99. ```
  100. Add a new component or template to the project passing component ID and choosing a name.
  101. ```bash
  102. ig add <component/template> <component_name>
  103. ```
  104. The ID matches either a component ("grid", "combo", "text-editor", etc) or a predefined template. Predefined templates are framework/project specific and can provide predefined views with either multiple components or fulfilling a specific use case like "form-validation", "master-detail" and so on.
  105. For full list of supported templates in the current project you can simply run [ig list](https://github.com/IgniteUI/igniteui-cli/wiki/List) command:
  106. ```bash
  107. ig list
  108. ```
  109. ### Build and run
  110. ```bash
  111. ig build
  112. ig start
  113. ```
  114. ### Search the docs
  115. `ig doc` searches the documentation bundled with the CLI and prints the results in the terminal. The framework is detected from the current project; pass `-f` outside a project.
  116. ```bash
  117. ig doc "row editing" # ranked results with the name of each doc
  118. ig doc --read grid-row-editing # print one doc by the name from the results
  119. ig doc "row editing" -f react --limit 5
  120. ig doc grid --open # search infragistics.com in the browser instead
  121. ```
  122. The bundled docs cover Angular, React, Web Components and Blazor. For jQuery use `--open`.
  123. ### Check your setup
  124. `ig doctor` checks the environment (Node.js, npm, git, CLI version), the current project (CLI config, installed Ignite UI packages, trial and licensed packages mixed together, Angular version match), the licensed `@infragistics` feed, and the AI setup written by `ig ai-config`. It changes nothing, prints a fix hint next to each warning or failure, and exits with code 1 when a check fails.
  125. ```bash
  126. ig doctor
  127. ig doctor --offline # skip the checks that need the network
  128. ig doctor --json # machine-readable results
  129. ```
  130. ## Configure AI Tooling
  131. Ignite UI provides rich [AI assisted development toolchain](https://www.infragistics.com/ai-assisted-app-development). To configure Ignite UI AI tooling — MCP servers and AI coding skills — run:
  132. ```bash
  133. ig ai-config
  134. ```
  135. You will be prompted with two selections:
  136. - **AI agents** — which tools to generate skill and instruction files for (Generic and Claude are selected by default)
  137. - **Coding assistants** — which assistants to configure MCP servers for (general `.mcp.json` is selected by default, compatible with Claude Code, VS Code, and others)
  138. You can also pass options directly:
  139. ```bash
  140. ig ai-config --agents claude copilot generic --assistants vscode cursor
  141. ```
  142. This creates or updates the assistant-specific MCP config file (e.g. `.mcp.json`, `.vscode/mcp.json`, `.cursor/mcp.json`) with entries for the [Ignite UI MCP](#mcp-server) and `igniteui-theming` MCP servers (existing servers are preserved), copies AI coding skill files from installed Ignite UI packages, and generates agent-specific instruction files (e.g. `CLAUDE.md`, `AGENTS.md`).
  143. The `ig new` command also prompts for AI tool configuration as part of project creation.
  144. ## MCP Server
  145. The CLI includes a bundled [MCP (Model Context Protocol)](https://modelcontextprotocol.io/) server that provides AI assistants with Ignite UI documentation search, API reference lookup, and scaffolding guidance for Angular, React, Blazor, and Web Components.
  146. Start the MCP server:
  147. ```bash
  148. ig mcp
  149. ```
  150. The server runs over stdio and supports the following options:
  151. ```bash
  152. ig mcp --remote <url> # Use a remote backend instead of the local SQLite database
  153. ig mcp --debug # Enable debug logging to mcp-server.log
  154. ```
  155. ### Using with AI Assistants
  156. For VS Code, the `ig ai-config` command handles configuration automatically (see above). For other MCP clients (e.g., Claude Desktop, Cursor), configure them manually:
  157. ```json
  158. {
  159. "mcpServers": {
  160. "igniteui-cli": {
  161. "command": "npx",
  162. "args": ["-y", "@igniteui/mcp-server"]
  163. },
  164. "igniteui-theming": {
  165. "command": "npx",
  166. "args": ["-y", "igniteui-theming", "igniteui-theming-mcp"]
  167. }
  168. }
  169. }
  170. ```
  171. In a project that lists `igniteui-cli` as a dependency, `ig ai-config` writes `"args": ["-y", "igniteui-cli", "mcp"]` instead, which starts the server bundled with the project's CLI. Use that form there too when configuring manually: with pnpm, `npx -y @igniteui/mcp-server` cannot start inside such a project.
  172. The first start downloads the server into the npx cache, which can take 10 seconds or more, and npx downloads it again after each new release. If your MCP client has a short connection timeout, install the server globally (`npm install -g @igniteui/mcp-server`) and use `"command": "igniteui-mcp"` with no arguments, or pin a version (`"args": ["-y", "@igniteui/mcp-server@<version>"]`). Pinned and global installs don't update on their own, so the bundled documentation stays at that version until you change it.
  173. The MCP server exposes the following tools to AI assistants:
  174. | Tool | Description |
  175. |------|-------------|
  176. | `list_components` | List available Ignite UI component docs. Filter by framework and optional keyword match against filename, component name, keywords, or summary. |
  177. | `get_doc` | Return the full markdown content of a specific component doc by name (e.g., `grid-editing`, `accordion`). |
  178. | `search_docs` | Full-text search across Ignite UI docs for a specific framework. Supports prefix matching (e.g., `grid*`). |
  179. | `search_api` | Search Ignite UI API entries by keyword, feature name, or partial component name. |
  180. | `get_api_reference` | Return the full API reference for a specific Ignite UI component or class by exact name. |
  181. | `get_project_setup_guide` | Returns setup guides for creating a new Ignite UI project. For Angular/React/Web Components: CLI scaffolding instructions. For Blazor: `dotnet new` + NuGet setup guide. |
  182. ### Testing with MCP Inspector
  183. To interactively test and debug the MCP server tools:
  184. ```bash
  185. npx @modelcontextprotocol/inspector ig mcp
  186. ```
  187. ## Schematics
  188. You can also add `Ignite UI for Angular` components to your projects by using the `igniteui/angular-schematics` package. It included schematic definitions for most of the logic present in the [`igniteui-cli`](/packages/cli). These can be called in any existing Angular project or even when creating one. You can learn more about the schematics package on from its [readme](/package/ng-schematics).
  189. ## Contribution
  190. See the [Contribution guide](https://github.com/IgniteUI/igniteui-cli/blob/master/.github/CONTRIBUTING.md) to get started.
  191. ### Run locally
  192. 1. Clone the repository
  193. 2. Install dependencies from the repository root with `npm ci` (installs exactly what `package-lock.json` records, for every workspace package, the MCP server included)
  194. 3. Build everything from the repository root: `npm run build` (compiles the monorepo packages, then builds the MCP server via `build:mcp`)
  195. 4. Open in Visual Studio Code
  196. There is a predefined launch.config file for VS Code in the root folder, so you can use VS Code View/Debug window and choose one of the predefined actions. These include launching the step by step guide, create new project for a particular framework or add components.
  197. 5. Hit Start Debugging/F5
  198. #### Template smoke test
  199. `scripts/smoke-test.sh` drives the locally built CLI end to end: it scaffolds a project, adds
  200. every component template into it, installs, runs `ig doctor`, and builds. The Jasmine specs under `spec/` stub out
  201. `PackageManager.installPackages`, so they verify that files land on disk but never that the result
  202. installs or compiles — this script covers that gap.
  203. ```bash
  204. npm run build # required: the script runs your local build, not the published CLI
  205. scripts/smoke-test.sh # angular, react and webcomponents (~20-30 min)
  206. ```
  207. Options:
  208. | Option | Meaning |
  209. |---|---|
  210. | `-f, --frameworks LIST` | comma separated; default `angular,react,webcomponents` |
  211. | `-p, --project ID` | project template to scaffold (default: the framework's own default) |
  212. | `--all-projects` | scaffold and build every project template, skip component adds |
  213. | `--templates LIST` | only these component template ids — the fast path when iterating |
  214. | `--isolate` | one project per component template; slow, use to bisect a failure |
  215. | `--wizard each\|pairs\|all` | create the projects through the interactive `ig new` wizard instead: every answer (`each`), every pair of answers (`pairs`) or every combination (`all`) |
  216. | `--skip-build` | scaffold and add only |
  217. | `--keep` | keep the generated projects even when everything passes |
  218. | `-o, --out DIR` | work directory (default `output/smoke`, which is gitignored) — **wiped on each run**, see below |
  219. | `-j, --jobs N` | frameworks to run in parallel (default 1) |
  220. ```bash
  221. scripts/smoke-test.sh -f angular --templates grid,combo # quick check, ~2 min
  222. scripts/smoke-test.sh -f angular --all-projects # every Angular project template
  223. scripts/smoke-test.sh -f webcomponents --isolate # bisect which template broke
  224. ```
  225. Per-step logs land in `<out>/logs/`, and `<out>/results.tsv` is a machine-readable
  226. `framework / step / template / status / seconds` table. The script exits non-zero if any step
  227. failed and prints a summary of the failures.
  228. The work directory is deleted and recreated on every run, so the script refuses to touch anything
  229. it cannot show is its own: the filesystem root, your home directory, the repository or any directory
  230. containing it, and any non-empty directory that lacks either the `.smoke-test-workdir` sentinel it
  231. drops or the `results.tsv` of an earlier run. Point `--out` elsewhere, or remove the directory
  232. yourself, if you hit that.
  233. Two things to know if you modify it:
  234. * **Call the CLI through `cli`, never `packages/cli/bin/execute.js`.** The wrapper delegates to
  235. `node_modules/igniteui-cli` whenever one resolves inside the current directory, and every project
  236. template lists `igniteui-cli` as a devDependency. Angular projects install theirs during `ig new`
  237. (`ng add` needs the packages), so through the wrapper `ig add` would silently switch to the
  238. *published* CLI and its bundled templates. `cli` loads this checkout's `packages/cli/lib/cli.js`
  239. instead. For the other frameworks, scaffolding with `--skip-install` still keeps
  240. `PackageManager.queuePackage` from spawning installs, so dependencies are written to
  241. `package.json` and installed once at the end.
  242. * **Exit codes are not sufficient.** `Util.error` logs and returns without setting one, so
  243. `ig add does-not-exist x` exits 0. Each step is judged on its exit code *and* an error scan of its
  244. log *and* an artifact check.
  245. jQuery and Blazor are opt-in via `-f`. jQuery has no build script and 13 of its templates pull
  246. `ignite-ui-full` from the Infragistics ProGet feed, which needs credentials; Blazor needs the .NET
  247. SDK and has no component templates, so only `dotnet build` runs.
  248. #### MCP Server development
  249. The MCP server at `packages/igniteui-mcp/igniteui-doc-mcp` has its own build pipeline, separate from the monorepo. It uses ESM (ES2022, Node16 modules) while the rest of the monorepo uses CommonJS. See [DEVELOPMENT.md](./packages/igniteui-mcp/igniteui-doc-mcp/DEVELOPMENT.md) for the full MCP server development guide.
  250. **Build the MCP server** (from the repo root, after `npm ci`):
  251. ```bash
  252. npm run build:mcp # Compiles the MCP server and copies the SQLite DB into its dist/ (also part of npm run build)
  253. ```
  254. **Regenerate API reference data** (maintainers only):
  255. The API reference data the server ships (`docs/*-api/`) is committed, so a normal build needs no submodules. To regenerate it after upstream API changes:
  256. ```bash
  257. cd packages/igniteui-mcp/igniteui-doc-mcp
  258. npm run build:docs:all # build:docs:angular-api, :wc-api, :react-api and :blazor-api in turn
  259. ```
  260. **Test the MCP server locally:**
  261. ```bash
  262. npm run build # includes build:mcp
  263. node packages/cli/lib/cli.js mcp # Start via CLI
  264. # or directly:
  265. node packages/igniteui-mcp/igniteui-doc-mcp/dist/index.js # Start the server
  266. ```
  267. #### Building the CLI packages for publishing
  268. The CLI does not bundle the MCP server: `igniteui-cli` depends on `@igniteui/mcp-server`, which is published from `packages/igniteui-mcp/igniteui-doc-mcp` alongside the other workspace packages. To build them the way the release workflow does:
  269. ```bash
  270. npm ci
  271. npm run build-pack # production build of every package, MCP server included; also refreshes the ai-config skills from the doc submodules
  272. ```
  273. `npm pack` in `packages/cli/` and in `packages/igniteui-mcp/igniteui-doc-mcp/` then produces the two tarballs; the MCP one contains the documentation database and the API reference data.
  274. ## Data Collection
  275. The Ignite UI CLI tool uses Google Analytics to anonymously report feature usage statistics and basic crash reports. This data is used to help improve the Ignite UI CLI tools over time. You can opt out of analytics before any data is sent by using
  276. ```bach
  277. ig config set disableAnalytics true -g
  278. ```
  279. when using the CLI. You can read Infragistics privacy policy at https://www.infragistics.com/legal/privacy.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.