SecaniDocumentation
OSCAL

CLI

Prévisualisez l'interface de ligne de commande prévue pour la validation et la conversion OSCAL.

Aperçu de l'installation

À venir: oscal-cli n'est pas encore publié. Chaque commande de cette page est illustrative.

La CLI est distincte de la boîte à outils TypeScript implémentée et n'est pas encore publiée. Les commandes de cette page décrivent le contrat CLI prévu, et non les fonctionnalités disponibles à partir de @secani/oscal aujourd'hui.

npm install --global oscal-cli

Valider

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

La validation est prévue pour vérifier un document par rapport au modèle OSCAL pertinent et renvoyer des diagnostics exploitables.

Convertir

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

La conversion est prévue pour les sérialisations JSON, XML et YAML d'OSCAL.

Inspecter

Les commandes d'inspection prévues résumeront le modèle, les identifiants et la structure de haut niveau d'un document sans modifier le fichier source.

oscal-cli inspect ./profile.json

Formats de sortie

Une sortie de terminal lisible par l'homme et une sortie lisible par machine pour les flux de travail automatisés sont prévues.

Codes de sortie

La CLI publiée documentera les codes de sortie stables pour les commandes réussies, les résultats de validation et les erreurs de commande.