CLI
Preview the planned command-line interface for OSCAL validation and conversion.
Installation preview
Coming soon:
oscal-cliis not published yet. Every command on this page is illustrative.
The CLI is separate from the implemented TypeScript toolkit and is not published yet. The commands on this page describe the intended CLI contract, not functionality available from @secani/oscal today.
npm install --global oscal-cliValidate
oscal-cli validate ./system-security-plan.jsonValidation is planned to check a document against the relevant OSCAL model and return actionable diagnostics.
Convert
oscal-cli convert ./catalog.xml --to jsonConversion is planned for OSCAL's JSON, XML, and YAML serializations.
Inspect
The planned inspection commands will summarize a document's model, identifiers, and high-level structure without changing the source file.
oscal-cli inspect ./profile.jsonOutput formats
Human-readable terminal output and machine-readable output for automated workflows are planned.
Exit codes
The published CLI will document stable exit codes for successful commands, validation findings, and command errors.
Validator
How the Secani OSCAL validator proves source-verified validation beyond the Java reference implementation – completeness closure, differential receipts, and honest limits.
Validation API
Validate OSCAL 1.2.2 JSON documents over HTTP – stateless, anonymous or with an API key, powered by the same engine as the browser validator.