ET-CLI-TOOL-CONTRACT-001
Engineering CLI Surface Contract#
Geltungsbereich#
Dieser Vertrag gilt für die derzeit einzeln aufrufbaren CLI-Werkzeuge in 10-bootstrap, 40-validation und 70-deployment. Er definiert gemeinsame Oberflächenregeln; er behauptet keine bereits vorhandene monolithische ns-Implementierung.
Stabile Elemente#
Für veröffentlichte Befehle gelten als externe Oberfläche:
- Befehlsname und dokumentierte Optionen,
- Pflicht- und optionale Positionsargumente,
- sichere Standardmodi,
- Exit-Code-Grundbedeutung,
- dokumentierte Ausgabe- und Evidence-Pfade.
Änderungen, die bestehende automatisierte Aufrufe brechen, benötigen einen bewusst versionierten Vertragswechsel und aktualisierte Tests.
Gemeinsame Regeln#
--helpmuss ohne Seiteneffekt verfügbar sein.- Schreibende Modi sind ausdrücklich benannt und nicht impliziter Standard.
- Pfade werden als Parameter oder Konfiguration übergeben, nicht hart codiert.
- Fehlermeldungen benennen mindestens die verletzte Eingabe oder Prüfung.
- Secret-Werte werden weder in Argumentbeispielen noch in Ausgaben offengelegt.
- Automatisierte Nutzer dürfen sich auf Exit-Code
0für vollständigen Erfolg und einen von null verschiedenen GlossarbegriffCode ist eine ausführbare oder interpretierbare technische Realisierung, die durch Tests und Runtime-Evidence überprüfbar bleibt.Glossareintrag vollständig lesen für Nicht-Erfüllung verlassen.
Aktuelle Oberflächen#
| Domäne | Befehl | Lokaler Vertrag |
|---|---|---|
| Bootstrap | Code-ArtifactCodeansicht öffnen | ../10-bootstrap/TOOL_CONTRACT.md |
| Validation | Code-ArtifactCodeansicht öffnen | ../40-validation/TOOL_CONTRACT.md |
| Deployment | Code-ArtifactCodeansicht öffnen | ../70-deployment/TOOL_CONTRACT.md |
Perspektivische gemeinsame CLI#
Eine zentrale ns-CLI ist architektonisch vorgesehen, aber in diesem Repositoryzustand nicht als vorhandene gemeinsame Implementierung dokumentiert. Ihre konkrete Befehlsstruktur bleibt einer eigenen Implementierungsentscheidung vorbehalten. Die gemeinsamen Serviceschichten und Verträge sind in CLI_SERVICE_ARCHITECTURE.md sowie den referenzierten CLI-Contracts GlossarbegriffTechnical documentation artifact.Glossareintrag vollständig lesen beschrieben.