C# |使用 System.CommandLine 庫建立命令列 (CLI) 應用程式

Note

You can check other posts on my personal website: 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<int>("--number", "An integer option"),
            new Option<bool>("--flag", "A boolean option"),
            new Argument<string>("input", "A required input argument")
        };

        rootCommand.Handler = CommandHandler.Create<int, bool, string>((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<int>("--number", "An integer option"),
    new Option<bool>("--flag", "A boolean option"),
    new Argument<string>("input", "A required input argument")
};

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

接下來做什麼？

您已使用 C# 和 .NET 中的 System.CommandLine 程式庫成功建立了基本的命令列介面 (CLI) 應用程式。根據您的具體要求自訂和擴展應用程式。
更多資訊請參考官方文件：System.CommandLine GitHub

以上是C# |使用 System.CommandLine 庫建立命令列 (CLI) 應用程式的詳細內容。更多資訊請關注PHP中文網其他相關文章！