CLI

Vorschau auf die geplante Kommandozeilenschnittstelle zur Validierung und Konvertierung von OSCAL.

Installationsvorschau

Demnächst verfügbar: oscal-cli ist noch nicht veröffentlicht. Jeder Befehl auf dieser Seite dient nur zur Veranschaulichung.

Die CLI ist vom implementierten TypeScript-Toolkit getrennt und noch nicht veröffentlicht. Die Befehle auf dieser Seite beschreiben den beabsichtigten CLI-Vertrag und keine Funktionalität, die heute in @secani/oscal verfügbar ist.

npm install --global oscal-cli

Validieren

oscal-cli validate ./system-security-plan.json

Die Validierung soll ein Dokument gegen das relevante OSCAL-Modell prüfen und verwertbare Diagnosen zurückgeben.

Konvertieren

oscal-cli convert ./catalog.xml --to json

Die Konvertierung ist für die JSON-, XML- und YAML-Serialisierungen von OSCAL geplant.

Untersuchen

Die geplanten Untersuchungsbefehle werden das Modell, die Identifikatoren und die grundlegende Struktur eines Dokuments zusammenfassen, ohne die Quelldatei zu verändern.

oscal-cli inspect ./profile.json

Ausgabeformate

Geplant sind menschenlesbare Terminalausgaben und maschinenlesbare Ausgaben für automatisierte Workflows.

Exit-Codes

Die veröffentlichte CLI wird stabile Exit-Codes für erfolgreiche Befehle, Validierungsfeststellungen und Befehlsfehler dokumentieren.