Notiz
Sie können andere Beiträge auf meiner persönlichen Website überprüfen: https://hbolajraf.net

Einführung

In diesem Handbuch erfahren Sie, wie Sie mithilfe der System.CommandLine-Bibliothek in C# und .NET eine Befehlszeilenschnittstellenanwendung (CLI) erstellen. System.CommandLine vereinfacht den Prozess der Erstellung robuster und funktionsreicher Befehlszeilenschnittstellen für Ihre Anwendungen.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Folgendes installiert ist:

• .NET SDK (Version 5.0 oder höher)

Schritt 1: Erstellen Sie eine neue Konsolenanwendung

dotnet new console -n MyCommandLineApp
cd MyCommandLineApp

Schritt 2: System.CommandLine NuGet-Paket hinzufügen

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

Schritt 3: Definieren Sie Befehlszeilenoptionen

Definieren Sie in Ihrer Program.cs die Befehlszeilenoptionen mit 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);
    }
}

Schritt 4: Führen Sie die CLI-App aus

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

Ersetzen Sie die Werte durch Ihre eigenen und sehen Sie sich die Ausgabe an.

Schritt 5: Hilfetext anpassen

Fügen Sie Beschreibungen zu Ihren Optionen und Argumenten hinzu, um einen besseren Hilfetext zu erhalten:

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}");
});

Was als nächstes?

Sie haben erfolgreich eine einfache Befehlszeilenschnittstellenanwendung (CLI) mithilfe der System.CommandLine-Bibliothek in C# und .NET erstellt. Passen Sie die Anwendung entsprechend Ihren spezifischen Anforderungen an und erweitern Sie sie.
Weitere Informationen finden Sie in der offiziellen Dokumentation: System.CommandLine GitHub