CLI erstellen
Entwerfen Sie die CLI-Oberfläche (Syntax + Verhalten), zuerst für Menschen, aber skriptfreundlich.
Zuerst erledigen
- Lesen Sie
agent-scripts/skills/create-cli/references/cli-guidelines.mdund wenden Sie es als Standard-Rubrik an. - Übergeordnete/vollständige Richtlinien: https://clig.dev/ (Änderungen vorschlagen: https://github.com/cli-guidelines/cli-guidelines)
- Stellen Sie nur die minimal notwendigen Klarheitsfragen, um die Schnittstelle festzulegen.
Klären (schnell)
Fragen Sie, und fahren Sie dann mit Standardannahmen fort, wenn der Benutzer unsicher ist:
- Befehlsname + Satz mit Zweck.
- Hauptbenutzer: Menschen, Skripte oder beides.
- Eingabequellen: Argumente vs. stdin; Dateien vs. URLs; Geheimnisse (niemals über Flags).
- Ausgabevertrag: Text für Menschen,
--json,--plain, Exit-Codes. - Interaktivität: Eingabeaufforderungen erlaubt?
--no-inputerforderlich? Bestätigungen bei destruktiven Operationen? - Konfigurationsmodell: Flags/Umgebung/Konfigurationsdatei; Rangfolge; XDG vs. repo-lokal.
- Plattform-/Laufzeitbeschränkungen: macOS/Linux/Windows; einzelne Binärdatei vs. Laufzeit.
Liefergegenstände (was auszugeben ist)
Erstellen Sie beim Entwerfen einer CLI eine kompakte Spezifikation, die der Benutzer implementieren kann:
- Befehlshaum + SYNOPSIS der Verwendung.
- Tabelle mit Argumenten/Flags (Typen, Standardwerte, erforderlich/optional, Beispiele).
- Semantik der Unterbefehle (was jeder tut; Idempotenz; Statusänderungen).
- Ausgaberegeln: stdout vs. stderr; TTY-Erkennung;
--json/--plain;--quiet/--verbose. - Fehler- + Exit-Code-Zuordnung (häufigste Fehlermodi).
- Sicherheitsregeln:
--dry-run, Bestätigungen,--force,--no-input. - Konfigurations-/Umgebungsregeln + Rangfolge (flags > umgebung > projektkonfiguration > benutzerkonfiguration > system).
- Shell-Vervollständigungsgeschichte (falls zutreffend): Installation/Auffindbarkeit; Generierungsbefehl oder gebündelte Skripte.
- 5–10 Beispielaufrufe (häufige Abläufe; Beispiele mit Pipe/stdin einschließen).
Standardkonventionen (sofern der Benutzer nichts anderes sagt)
-h/--helpzeigt immer Hilfe an und ignoriert andere Argumente.--versiongibt die Version auf stdout aus.- Primäre Daten auf stdout; Diagnosen/Fehler auf stderr.
- Fügen Sie
--jsonfür Maschinenausgabe hinzu; erwägen Sie--plainfür stabile zeilenbasierte Textausgabe. - Eingabeaufforderungen nur, wenn stdin ein TTY ist;
--no-inputdeaktiviert Eingabeaufforderungen. - Destruktive Operationen: interaktive Bestätigung + nicht-interaktiv erfordert
--forceoder explizites--confirm=.... - Respektieren Sie
NO_COLOR,TERM=dumb; stellen Sie--no-colorbereit. - Ctrl-C behandeln: schnell beenden; begrenzte Bereinigung; wenn möglich nur auf Absturz ausgelegt.
Vorlagen (in Ihre Antwort kopieren)
CLI-Spezifikationsgerüst
Füllen Sie diese Abschnitte aus, entfernen Sie alles Unwichtige:
- Name:
mycmd - Einzeiler:
... - VERWENDUNG:
mycmd [globale Flags] <unterbefehl> [argumente]
- Unterbefehle:
mycmd init ...mycmd run ...
- Globale Flags:
-h, --help--version-q, --quiet/-v, --verbose(genau definieren)--json/--plain(falls zutreffend)
- I/O-Vertrag:
- stdout:
- stderr:
- Exit-Codes:
0Erfolg1allgemeiner Fehler2ungültige Verwendung (Parse-/Validierungsfehler)- (fügen Sie befehlsspezifische Codes nur hinzu, wenn sie tatsächlich nützlich sind)
- Umgebung/Konfiguration:
- Umgebungsvariablen:
- Konfigurationsdateipfad + Rangfolge:
- Beispiele:
- …
Hinweise
- Bevorzugen Sie die Empfehlung einer Parsing-Bibliothek (sprachspezifisch) nur auf Nachfrage; andernfalls halten Sie dieses Skill sprachunabhängig.
- Wenn die Anfrage „Parameter entwerfen“ lautet, nicht in die Implementierung abdriften.