注記
私の個人ウェブサイトで他の投稿をチェックできます: https://hbolajraf.net

導入

このガイドでは、C# および .NET で System.CommandLine ライブラリを使用してコマンド ライン インターフェイス (CLI) アプリケーションを構築する方法を説明します。 System.CommandLine は、アプリケーション用の堅牢で機能豊富なコマンド ライン インターフェイスを作成するプロセスを簡素化します。

前提条件

始める前に、以下がインストールされていることを確認してください:

• .NET SDK (バージョン 5.0 以降)

ステップ 1: 新しいコンソール アプリケーションを作成する

dotnet new console -n MyCommandLineApp
cd MyCommandLineApp

ステップ 2: System.CommandLine NuGet パッケージを追加する

dotnet add package System.CommandLine --version 2.0.0-beta1.21308.1

ステップ 3: コマンドライン オプションを定義する

Program.cs で、System.CommandLine:
を使用してコマンド ライン オプションを定義します。

using System.CommandLine;
using System.CommandLine.Invocation;

class Program
{
    static int Main(string[] args)
    {
        var rootCommand = new RootCommand
        {
            new Option("--number", "An integer option"),
            new Option("--flag", "A boolean option"),
            new Argument("input", "A required input argument")
        };

        rootCommand.Handler = CommandHandler.Create((number, flag, input) =>
        {
            // Your application logic goes here
            Console.WriteLine($"Number: {number}");
            Console.WriteLine($"Flag: {flag}");
            Console.WriteLine($"Input: {input}");
        });

        return rootCommand.Invoke(args);
    }
}

ステップ 4: CLI アプリを実行する

dotnet run -- --number 42 --flag true "Hello, CLI!"

値を独自の値に置き換えて、出力を確認します。

ステップ 5: ヘルプ テキストをカスタマイズする

ヘルプ テキストを改善するために、オプションと引数に説明を追加します:

var rootCommand = new RootCommand
{
    new Option("--number", "An integer option"),
    new Option("--flag", "A boolean option"),
    new Argument("input", "A required input argument")
};

rootCommand.Description = "A simple CLI app";
rootCommand.Handler = CommandHandler.Create((number, flag, input) =>
{
    Console.WriteLine($"Number: {number}");
    Console.WriteLine($"Flag: {flag}");
    Console.WriteLine($"Input: {input}");
});

次は何？

C# と .NET の System.CommandLine ライブラリを使用して、基本的なコマンド ライン インターフェイス (CLI) アプリケーションを正常に作成できました。特定の要件に基づいてアプリケーションをカスタマイズおよび拡張します。
詳細については、公式ドキュメント System.CommandLine GitHub