{"id":15560987,"url":"https://github.com/igniteui/igniteui-cli","last_synced_at":"2026-04-02T12:59:57.199Z","repository":{"id":37458242,"uuid":"106006714","full_name":"IgniteUI/igniteui-cli","owner":"IgniteUI","description":"Ignite UI Command-Line Interface by Infragistics","archived":false,"fork":false,"pushed_at":"2025-05-13T11:37:23.000Z","size":21761,"stargazers_count":119,"open_issues_count":9,"forks_count":4,"subscribers_count":43,"default_branch":"master","last_synced_at":"2025-05-13T11:50:00.385Z","etag":null,"topics":["angular","build-automation","cli","ignite-ui","jquery","react","scaffolding","test-automation"],"latest_commit_sha":null,"homepage":"https://bit.ly/2L19rhp","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IgniteUI.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-10-06T13:17:49.000Z","updated_at":"2025-04-25T06:02:23.000Z","dependencies_parsed_at":"2023-07-25T18:43:41.098Z","dependency_job_id":"adea12b0-9127-4ba5-9971-ba02452de65d","html_url":"https://github.com/IgniteUI/igniteui-cli","commit_stats":{"total_commits":1984,"total_committers":37,"mean_commits":53.62162162162162,"dds":0.8155241935483871,"last_synced_commit":"bccecd6cd01cf597ec2e36f34f0343bff8d7f9ab"},"previous_names":["igniteui/ignite-ui-cli"],"tags_count":466,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IgniteUI%2Figniteui-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IgniteUI","download_url":"https://codeload.github.com/IgniteUI/igniteui-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254453667,"owners_count":22073618,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","build-automation","cli","ignite-ui","jquery","react","scaffolding","test-automation"],"created_at":"2024-10-02T16:04:41.138Z","updated_at":"2026-04-02T12:59:57.181Z","avatar_url":"https://github.com/IgniteUI.png","language":"TypeScript","readme":"\n## Ignite UI CLI\n\n\u003c!-- Badges section here. --\u003e\n![Node.js CI](https://github.com/IgniteUI/igniteui-cli/workflows/Node.js%20CI/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/IgniteUI/igniteui-cli/badge.svg)](https://coveralls.io/github/IgniteUI/igniteui-cli)\n[![npm version](https://badge.fury.io/js/igniteui-cli.svg)](https://badge.fury.io/js/igniteui-cli)\n[![Discord](https://img.shields.io/discord/836634487483269200?logo=discord\u0026logoColor=ffffff)](https://discord.gg/39MjrTRqds)\n\nQuickly create projects including [Ignite UI for Angular](https://www.infragistics.com/products/ignite-ui-angular) and [Ignite UI for jQuery](https://www.infragistics.com/products/ignite-ui) components for a variety of frameworks.\n\n## Overview\n### Features:\n- Create project structure\n- Add views with Ignite UI components (e.g. Combo, Grid or Chart)\n- Add scenario based templates with multiple components (e.g. a dashboard)\n- Build and install npm packages\n- Select a theme, support for custom themes coming soon\n- Step by step guide\n\n### Supported frameworks\n * jQuery\n * Angular\n * React\n\n### Prerequisites\nThe repository houses multiple packages and orchestrates building and publishing them with [lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://yarnpkg.com/lang/en/docs/workspaces/).\n\nIn order to build the repository locally, you need to have `yarn` installed on your machine.\nFor installation instructions, please visit their [official page](https://yarnpkg.com/lang/en/docs/install/)\n\n### Packages\nThis monorepo contains several packages that combine into the `igniteui-cli`:\n\n| Package | Description | Location |\n|-----|-----|-----|\n| [@igniteui/cli-core](https://www.npmjs.com/package/@igniteui/cli-core) | Contains the core functionality of the cli tool | [packages/core](./packages/core) |\n| [@igniteui/angular-templates](https://www.npmjs.com/package/@igniteui/angular-templates) | Contains the template definitions for Angular components | [packages/igx-templates](./packages/igx-templates) |\n| [@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) |\n| [igniteui-cli](https://www.npmjs.com/package/igniteui-cli) | Standalone IgniteUI CLI tool for React, jQuery and Angular | [packages/cli](./packages/cli) |\n| [@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) |\n\n## Table of Contents\n\n* [Installation](#installation)\n* [Usage](#usage)\n  * [Step by step](#step-by-step)\n  * [List available commands](#list-the-available-commands)\n  * [Generating Projects and adding components](#generating-projects-and-adding-components)\n  \t* [Generate Ignite UI for Angular project](#generate-ignite-ui-for-angular-project)\n\t* [Generate Ignite UI for React project](#generate-ignite-ui-for-react-project)\n\t* [Adding components](#adding-components)\n  * [Build and run](#build-and-run)\n* [MCP Server](#mcp-server)\n  * [Using with AI Assistants](#using-with-ai-assistants)\n  * [Testing with MCP Inspector](#testing-with-mcp-inspector)\n* [Schematics](#schematics)\n  * [Schematic Definitions](#schematic-definitions)\n* [Contribution](#contribution)\n\n## Installation\n\nInstall the npm package as a global module:\n\n```bash\nnpm install -g igniteui-cli\n```\n\n## Usage\nThe 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.\n\n### Step by step\nTo get a guided experience through the available options, simply run:\n\n```bash\nig\n```\n![](assets/igniteui-cli.gif)\n\n\nUpon creation, project will be automatically loaded in the default browser.\n**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.\n\n\n### List the available commands.\n\n```bash\nig help\n```\n### Generating projects and adding components\n\nCreate a new project passing name, framework and style theme.\n```bash\nig new \u003cproject name\u003e --framework=\u003cframework\u003e --type=\u003cproj-type\u003e --theme=\u003ctheme\u003e\n```\nThis will create the project and will install the needed dependencies.\n\nParameters besides name are optional. Framework default to \"jquery\", 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.\n\n#### Generate Ignite UI for Angular project\n\nTo 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):\n```bash\nig new \"IG Project\" --framework=angular --type=igx-ts --template=side-nav\n```\n#### Generate Ignite UI for React project\n\nTo 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:\n```bash\nig new \"IG Project\" --framework=react --type=igr-ts\n```\n#### Generate Ignite UI for Web Components project\n\nTo 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:\n```bash\nig new \"IG Project\" --framework=webcomponents\n```\n\n#### Adding components\nOnce 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:\n\n```bash\nig add\n```\nAdd a new component or template to the project passing component ID and choosing a name.\n\n```bash\nig add \u003ccomponent/template\u003e \u003ccomponent_name\u003e\n```\n\nThe 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.\n\nFor full list of supported templates in the current project you can simply run [ig list](https://github.com/IgniteUI/igniteui-cli/wiki/List) command:\n```bash\nig list\n```\n\n### Build and run\n```bash\nig build\nig start\n```\n\n## MCP Server\n\nThe 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.\n\nStart the MCP server:\n```bash\nig mcp\n```\n\nThe server runs over stdio and supports the following options:\n```bash\nig mcp --remote \u003curl\u003e   # Use a remote backend instead of the local SQLite database\nig mcp --debug          # Enable debug logging to mcp-server.log\n```\n\n### Using with AI Assistants\n\nConfigure your MCP client (e.g., VS Code, Claude Desktop, Cursor) to use the CLI as the MCP server:\n\n```json\n{\n  \"mcpServers\": {\n    \"igniteui-cli\": {\n      \"command\": \"ig\",\n      \"args\": [\"mcp\"]\n    }\n  }\n}\n```\n\nThe MCP server exposes the following tools to AI assistants:\n\n| Tool | Description |\n|------|-------------|\n| `list_components` | List available Ignite UI component docs for a framework |\n| `get_doc` | Fetch full markdown content of a specific component doc |\n| `search_docs` | Full-text search across Ignite UI documentation |\n| `get_api_reference` | Retrieve the full API reference for a component or class |\n| `search_api` | Search API entries by keyword or partial component name |\n| `generate_ignite_app` | Return a setup guide for a new Ignite UI project |\n\n### Testing with MCP Inspector\n\nTo interactively test and debug the MCP server tools:\n```bash\nnpx @modelcontextprotocol/inspector ig mcp\n```\n\n## Schematics\nYou 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).\n\n## Contribution\n\nSee the [Contribution guide](https://github.com/IgniteUI/igniteui-cli/blob/master/.github/CONTRIBUTING.md) to get started.\n\n### Run locally\n1. Clone the repository\n2. Install dependencies with `yarn install`\n3. Build the MCP server and bundle it into the CLI:\n    ```bash\n    cd packages/igniteui-mcp/igniteui-doc-mcp\n    npm install\n    npm run build\n    cd ../../..\n    npm run build:mcp-bundle\n    ```\n4. Build the monorepo packages: `npm run build`\n5. Open in Visual Studio Code\n    \n    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.\n\n6. Hit Start Debugging/F5\n\n#### MCP Server development\n\nThe 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.\n\n**Build the MCP server:**\n```bash\ncd packages/igniteui-mcp/igniteui-doc-mcp\nnpm install          # Install MCP-specific dependencies (separate from yarn workspaces)\nnpm run build        # Compile TypeScript + copy SQLite DB to dist/\n```\n\n**Build API reference documentation:**\n\nThe MCP server includes API reference docs for Angular, React, and Web Components. Angular and Web Components docs are generated from framework submodules via TypeDoc (submodules are auto-initialized by the build scripts). React uses a pre-built TypeDoc JSON model checked into git.\n\n```bash\ncd packages/igniteui-mcp/igniteui-doc-mcp\nnpm run build:docs:angular         # Angular: init submodule → TypeDoc → markdown + index.json\nnpm run build:docs:webcomponents   # Web Components: init submodule → build lib → TypeDoc → markdown + index.json\nnpm run build:docs:all             # Build both\n```\n\n\u003e **Note:** Web Components requires a one-time library build (`npm run build:publish` in the submodule) before TypeDoc can run. The build script handles this automatically.\n\n**Bundle MCP into CLI** (from the repo root):\n```bash\nnpm run build:mcp-bundle    # Copies dist/ and docs/ into packages/cli/mcp/\n```\n\nThis copies the compiled MCP server, SQLite documentation database, and API reference docs into the CLI package. The `packages/cli/mcp/` directory is a build artifact (gitignored) and must be regenerated before publishing.\n\n**Test the MCP server locally:**\n```bash\nnpm run build:mcp-bundle\nnpm run build\nnode packages/cli/lib/cli.js mcp          # Start via CLI\n# or directly:\nnode packages/cli/mcp/dist/index.js       # Start the bundled server\n```\n\n#### Building CLI package with bundled MCP server\n\nThe CLI package includes the MCP server as a bundled build artifact (not an npm dependency). To produce a complete CLI package with full MCP functionality, follow these steps:\n\n```bash\n# 1. Install monorepo dependencies\nyarn install\n\n# 2. Build the MCP server\ncd packages/igniteui-mcp/igniteui-doc-mcp\nnpm install\nnpm run build                              # Compile TypeScript + copy SQLite DB\n\n# 3. Build API reference docs (optional but recommended for full functionality)\nnpm run build:docs:all                     # Init submodules + generate Angular + WC API docs via TypeDoc\n\n# 4. Bundle MCP into CLI (from repo root)\ncd ../../..\nnpm run build:mcp-bundle                   # Copy dist/ + docs/ → packages/cli/mcp/\n\n# 5. Build all packages for publishing\nnpm run build-pack\n```\n\nAfter step 5, `npm pack` from the repo root or `packages/cli/` will produce a tarball with the MCP server, documentation database, and API reference docs all included.\n\n\u003e **Skipping API docs:** If you skip step 3, the MCP server will still work for `list_components`, `get_doc`, `search_docs`, and `generate_ignite_app` tools using the bundled SQLite database. Only the `get_api_reference` and `search_api` tools require API docs.\n\n## Data Collection\n\nThe 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\n\n```bach\nig config set disableAnalytics true -g\n```\n\nwhen using the CLI. You can read Infragistics privacy policy at https://www.infragistics.com/legal/privacy.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figniteui%2Figniteui-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figniteui%2Figniteui-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figniteui%2Figniteui-cli/lists"}