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中文网其他相关文章！