SecaniDocumentazione
OSCAL

CLI

Visualizza in anteprima l'interfaccia della riga di comando pianificata per la convalida e la conversione OSCAL.

Anteprima dell'installazione

Prossimamente: oscal-cli non è ancora pubblicato. Ogni comando in questa pagina è illustrativo.

La CLI è separata dal toolkit TypeScript implementato e non è ancora stata pubblicata. I comandi in questa pagina descrivono il contratto CLI previsto, non le funzionalità disponibili da @secani/oscal Oggi.

npm install --global oscal-cli

Convalidare

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

La convalida è pianificata per confrontare un documento con il modello OSCAL pertinente e restituire una diagnostica utilizzabile.

Convertire

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

È prevista la conversione per le serializzazioni JSON, XML e YAML di OSCAL.

Ispezionare

I comandi di ispezione pianificati riepilogheranno il modello, gli identificatori e la struttura di alto livello di un documento senza modificare il file di origine.

oscal-cli inspect ./profile.json

Formati di output

Sono previsti output terminali leggibili dall'uomo e output leggibili dalle macchine per flussi di lavoro automatizzati.

Codici di uscita

La CLI pubblicata documenterà i codici di uscita stabili per i comandi riusciti, i risultati della convalida e gli errori dei comandi.