So verwenden Sie die Cobra -Bibliothek für CLI -Apps in Golang

Cobra ist eine beliebte GO -Bibliothek zum Aufbau von CLI -Anwendungen, die von Kubernetes, Hugo und Docker verwendet werden. 2. Installieren Sie COBRA über Go Get and initialisieren Sie ein Projekt mit Cobra Init, das die Grundstruktur festlegt. 3. Erstellen Sie Befehle und Unterbefehle mit COBRA -Add und definieren ihr Verhalten in generierten GO -Dateien. 4. Fügen Sie Flags hinzu - loger oder anhaltend -, um das Befehlsverhalten anzupassen und in der Run -Funktion auf sie zuzugreifen. 5. Integrieren Sie Viper für die Konfigurationsdateiunterstützung in JSON-, YAML- oder TOML -Formaten. 6. Cobra generiert automatisch Hilfetext und unterstützt die Erzeugung der Dokumentation im Markdown- oder Man -Seitenformat. 7. Das Muster der Definition von Befehlen, das Anbringen von Flags und die Verwendung von Viper ermöglicht skalierbare, wartbare CLIs.

Die Cobra -Bibliothek ist eine der beliebtesten Go-Bibliotheken, um leistungsstarke Befehlszeilenschnittstellen (CLIS) zu erstellen. Es wird von Großprojekten wie Kubernetes, Hugo und Docker verwendet. Cobra vereinfacht das Erstellen robuster CLI-Apps mit Unterstützung für Befehle, Unterbefehle, Flaggen und automatisch generierte Hilfe. Hier erfahren Sie, wie Sie es effektiv verwenden können.

Installieren und initialisieren Sie Cobra

Beginnen Sie mit der Installation von Cobra mit GO -Modulen:

Um eine einfache CLI -App zu senken, können Sie den Cobra -Generator verwenden. Installieren Sie zunächst das Cobra CLI -Werkzeug:

Dann initialisieren Sie Ihr Projekt:

Dadurch wird eine Main.go -Datei und eine CMD/root.go -Datei erstellt, wobei die Grundstruktur eingerichtet wird.

Erstellen Sie Befehle und Unterbefehle

Cobra organisiert die Funktionalität um Befehle und Unterbefehle. Der Root -Befehl ist in cmd/root.go definiert. Um einen neuen Untertrag wie Serve hinzuzufügen, rennen Sie:

Dies generiert eine neue Datei cmd/serv.go mit einer vorgefüllten Befehlsstruktur:

Registrieren Sie es in Init (), damit es dem Root -Befehl beigefügt ist. Jetzt können Sie rennen:

Fügen Sie Flags und Konfiguration hinzu

Mit Flags können Benutzer das Befehlsverhalten anpassen. Cobra unterstützt anhaltende Flaggen (für alle Unterbefehle verfügbar) und lokale Flaggen (nur für einen bestimmten Befehl).

Fügen Sie in Ihrer Befehlsdefinition Flags in die Funktion "Init () hinzu:

Sie können auf den Flag -Wert in der Auslauffunktion zugreifen:

Für Konfigurationsdateien funktioniert Cobra gut mit Viper , einer anderen Bibliothek desselben Autors. Aktivieren Sie Viper in Ihrem Root -Befehl:

Lesen Sie dann die Konfiguration von JSON-, YAML- oder TOML -Dateien basierend auf Benutzereingaben oder Standardeinstellungen.

Autogenerierte Hilfe und Dokumentation

Cobra generiert automatisch Hilfe -Text. Laufen:

Sie werden strukturierte Ausgaberlistenbefehle, Unterbefehle und Flaggen sehen. Sie können Hilfenachrichten mit den kurzen und langen Feldern in Ihren Befehlsdefinitionen anpassen.

Cobra unterstützt auch die Generierung von CLI -Dokumentationen im Markdown- oder Man -Seitenformat, das für die Veröffentlichung von Benutzerführer nützlich ist.

Grundsätzlich gibt Ihnen Cobra eine saubere, skalierbare Möglichkeit, CLIS in Go zu bauen. Befehle definieren, Flags anhängen, optional Viper für die Konfiguration integrieren und COBRA -Routing behandeln und helfen. Es ist nicht schwer, wenn Sie das Muster verstanden haben.

Das obige ist der detaillierte Inhalt vonSo verwenden Sie die Cobra -Bibliothek für CLI -Apps in Golang. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!