ET-CLI-COMMAND-OPTION-CONTRACT-001

CLI Command and Option Contract#

Befehlsnamen#

Bestehende Skriptnamen sind veröffentlichte Oberflächen, sobald sie in Dokumentation oder Automatisierung referenziert werden. Umbenennungen benötigen Migration, Kompatibilitätsnachweis und aktualisierte Tests.

Argumente und Optionen#

• Pflichtargumente stehen nur für fachlich unvermeidbare Eingaben.
• Optionale Pfade werden mit benannten Optionen übergeben.
• Boolesche Schreibmodi werden ausdrücklich aktiviert, beispielsweise --apply.
• Auswahlwerte werden begrenzt und in --help ausgewiesen.
• Umgebungsvariablen dürfen dokumentierte Defaults liefern; CLI-Argumente haben Vorrang.
• Relative Pfade werden gegen einen eindeutig dokumentierten Bezugspunkt aufgelöst.

Sichere Defaults#

Prüfende oder planende Ausführung ist Standard. Schreibende Aktionen benötigen eine erkennbare Aktivierung oder gehören zu einem ausdrücklich als Deployment bezeichneten Befehl.

Kompatibilität#

Breaking Changes sind insbesondere:

• Entfernen oder Umbenennen veröffentlichter Optionen,
• Ändern der ⌘BedeutungBedeutung beschreibt den fachlichen Sinn eines Elements und seine Relevanz für Menschen und Organisationen. eines bestehenden Flags,
• Wechsel des Default-Zielpfads mit Seiteneffekt,
• Änderung der Exit-Code-Grundbedeutung,
• Verlagerung dokumentierter ⌘EvidenceTechnical documentation artifact. ohne Übergang.

Aktueller Optionsbestand#