React Ignite UI CLI

CLI ツールでは、Ignite UI for React の定義済みのプロジェクトテンプレートが含まれ、アプリ開発を効率的に行うことができます。

is a stand-alone command-line tool for creating and scaffolding your applications for a variety of different frameworks and provides a substantial productivity boost for developers.

作業の開始

まずは CLI をインストールします。

npm install -g igniteui-cli

上記のインストールコマンドは、Ignite UI CLI を Ignite UI for React アプリケーションの作成、スキャフォールディング、および実行に使用できるようにします。

新しいプロジェクトの作成

Ignite UI CLI を使用して、Ignite UI for React コントロールを使用するように構成されたアプリケーションを作成するには、コマンドラインで次のテンプレートを使用できます。

React プロジェクトを非対話的に作成するには、フレームワークとして react、プロジェクトタイプとして igr-ts を指定します。

ig new <project-name> --framework=react --type=igr-ts --template=side-nav

React で使用できる基本プロジェクトテンプレートは次のとおりです。

テンプレート ID	説明
empty	事前定義されたビューのない最小プロジェクト構造。このテンプレートでは認証は使用できません。
side-nav	サイドナビゲーションドロワーを備えたプロジェクト構造。認証をアドオンとして追加できます (以下を参照)。
side-nav-mini	コンパクトなサイドナビゲーションドロワーを備えたプロジェクト構造。認証をアドオンとして追加できます (以下を参照)。

インタラクティブなウィザードを使用する場合、side-nav または side-nav-mini を選択すると認証を追加するかどうかを確認する追加のプロンプトが表示されます。empty を選択すると認証プロンプトはスキップされます。以下のテンプレート ID が生成され、非対話的な作成に ig new で直接使用することもできます。これらはウィザードのテンプレート一覧には表示されません。

テンプレート ID	説明
side-nav-auth	認証機能付きのサイドナビゲーション。
side-nav-mini-auth	認証機能付きのサイドナビゲーションミニ。

コンポーネントの追加

プロジェクトの作成後は、いつでも ig add を使用してコンポーネントテンプレートを追加することができます。パラメーターを指定せずにこのコマンドを実行した場合、キーボードナビゲーション CLI を使用して、選択したコントロールを追加することにより、使用可能なテンプレートが示されます。

ig add

または、単に ig list コマンドを実行して、現在のプロジェクトでサポートされているテンプレートの完全なリストを取得することもできます。

ig list

ig list を実行し、追加したいコンポーネントテンプレートを見つけた後、コマンドラインでこのテンプレートを実行することにより、すばやく追加することができます。

ig add [component_template] [component_name]

上記の「component_template」は通常、Ignite UI for React コンポーネント (grid、category-chart、linear-gauge など) と一致します。

たとえば、「MyGridComponent」という名前のデータグリッドテンプレートコンポーネントをアプリに追加する場合は、次のコマンドを実行します。

ig add grid MyGridComponent

ルーティングファイルは、新しいコンポーネントを含むページへのパス (この場合は /my-grid-component) で更新されます。これを使用して、新しく生成されたページに手動で移動できます。

アプリをビルドして実行する

Ignite UI for React アプリをビルドして実行するには、ig build コマンドと ig run コマンドを呼び出します。

ig build
ig run

Vite の使用

Ignite UI CLI によって生成された React アプリケーションは、ビルドツールとして Vite を利用します。Vite は高速な開発および本番ビルドを提供し、開発中のホットモジュール交換 (HMR) などの機能を備えた効率的な開発エクスペリエンスを提供します。

Ignite UI CLI コマンド

使用可能な Ignite UI CLI コマンドとその使用方法 (フラグを渡すなど) の完全なリストは、Ignite UI CLI wiki ページにあります。

コマンド	エイリアス	説明
ig start		アプリケーションをビルドしてウェブサーバーを開始、次にアプリケーションをデフォルトブラウザーで開きます。
ig build		アプリケーションをアプトプットディレクトリへビルドします。
ig generate	g	サポートされるフレームワークおよびプロジェクトタイプのための新しいカスタムテンプレートを生成します。
ig help	-h	使用可能なコマンドをリストして手順の簡単な説明を示します。
ig config		Ignite UI CLI 構成設定の読み取り / 書き込み操作を実行します。
ig doc		検索した用語についてインフラジスティックスのサポート情報を検索します。
ig list	l	指定したフレームワークとタイプのすべてのテンプレートをリストします。プロジェクトフォルダー内でコマンド実行時にプロジェクトのフレームワークとタイプのテンプレートをすべてリストします。
ig test		現在のプロジェクトのテストを実行します。
ig upgrade-packages		プロジェクトの Ignite UI パッケージをトライアルからライセンス版にアップグレードします。
ig mcp		AI コーディングアシスタントを Ignite UI for React コンポーネントドキュメントに接続するための組み込み MCP サーバーを起動します。
ig ai-config		MCP サーバーを構成し、エージェントスキルファイルを各エージェントのスキルディレクトリにコピーします。`--assistants` および `--agents` フラグまたはインタラクティブモードをサポートします。
ig version	-v	ローカル (ローカルがない場合はグローバル) にインストールされた Ignite UI CLI バージョンを示します。