📒

Nest CLIのインストールと使い方

2023/06/12に公開

Nest CLI(コマンドラインインターフェース)は、NestJSプロジェクトの開発をスムーズに行うための強力なツールです。本記事では、Nest CLIのインストール方法と基本的な使い方について説明します。Nest CLIを使うことで、簡単にモジュール、コントローラ、サービスなどのコンポーネントを生成することができます。

1. Nest CLIのインストール

Nest CLIを使うには、まずNode.jsのインストールが必要です。以下の手順に従ってNest CLIをインストールしましょう。

  1. Node.jsのインストール:

  2. Nest CLIのグローバルインストール:

    • ターミナルを開き、以下のコマンドを実行します。
      npm install -g @nestjs/cli
      
    • 上記のコマンドを実行すると、Nest CLIがグローバルにインストールされます。
  3. インストールの確認:

    • ターミナルで以下のコマンドを実行して、Nest CLIが正しくインストールされたか確認します。
      nest --version
      
    • 正常にインストールされていれば、Nest CLIのバージョン番号が表示されます。

2. Nest CLIの使い方

Nest CLIを使ってNestJSプロジェクトを素早く開発するためには、いくつかのコマンドを覚える必要があります。以下に代表的なコマンドの使い方を説明します。

  1. モジュールの生成:

    nest g module <module-name>
    
    • <module-name>には作成するモジュールの名前を指定します。
    • 指定した名前のモジュールが生成されます。
  2. コントローラの生成:

    nest g controller <controller-name>
    
    • <controller-name>には作成するコントローラの名前を指定します。
    • 指定した名前のコントローラが生成されます。
  3. サービスの生成:

    nest g service <service-name>
    
    • <service-name>には作成するサービスの名前を指定します。
    • 指定した名前のサービスが生成されます。

ゲートウェイ、エンティティ、ミドルウェア、フィルター、パイプなどのコンポーネントを生成するためのコマンドがあります。必要に応じて公式ドキュメントを参照してください。

以上がNest CLIのインストールと使い方の概要です。Nest CLIを使うことで、簡単かつ効率的にNestJSプロジェクトを開発することができます。

参考:
https://docs.nestjs.com/cli/usages

PLAINCODE TECH BLOG

Discussion