ET-CLI-EXIT-OUTPUT-ERROR-CONTRACT-001

CLI Exit, Output and Error Contract#

Exit-Codes#

• 0: Der angeforderte Vorgang wurde vollständig erfolgreich abgeschlossen.
• 1: Fachliche Prüfung nicht erfüllt oder ausführbarer Vorgang fehlgeschlagen.
• 2: Eingabe oder Konfiguration ist ungültig, sofern der konkrete ⌘ServiceEin Service ist eine abgegrenzte bereitgestellte technische oder fachliche Leistung mit klarer Verantwortung. diesen Unterschied bereits anbietet.
• Weitere Codes dürfen nur lokal dokumentiert und durch Tests abgesichert werden.

Automatisierung darf sich immer auf 0 versus ungleich 0 verlassen. Eine feinere Interpretation ist nur zulässig, wenn der lokale Tool Contract sie ausdrücklich festlegt.

Ausgabekanäle#

• Erfolgszusammenfassungen und erzeugte Reportpfade: stdout.
• Fehler, verletzte Prüfungen und nicht erfüllte Voraussetzungen: stderr.
• Diagnoseausgaben dürfen keine Secrets enthalten.
• Mehrere Findings werden einzeln und mit stabil erkennbarem Präfix ausgegeben.

Fehlermeldungen#

Eine Fehlermeldung benennt mindestens:

1. die fehlgeschlagene Prüfung oder Aktion,
2. die betroffene Eingabe oder den betroffenen Pfad,
3. soweit möglich die zulässige Korrekturrichtung.

⌘EvidenceTechnical documentation artifact. vor Detailausgabe#

Schreibende Services geben den Pfad ihrer ◆EvidenceTechnical documentation artifact. auch im Fehlerfall aus, sofern Evidence erzeugt werden konnte. Logs ersetzen nicht den Exit-Code; der Exit-Code ersetzt nicht die Evidence.