overview
Type
External
Status
Published
Created
Jul 18, 2026
Updated
Jul 18, 2026

Commands Overview#

opnDossier provides the following commands for working with OPNsense and pfSense configuration files. Commands that parse config.xml auto-detect the device type from the XML root element (<opnsense> or <pfsense>).

CommandAliasPurpose
auditRun security audit and compliance checks on configurations
convertconvConvert config.xml to structured output formats
displayRender config.xml as formatted Markdown in terminal
validateCheck config.xml for structural and semantic correctness
diffCompare two OPNsense configuration files
sanitizeRedact sensitive information from config.xml
configManage opnDossier configuration (init, show, validate)
versionDisplay version information

For global flags (--verbose, --quiet, --config, etc.), see Configuration Reference. For the exhaustive auto-generated flag list for every command (regenerated from the Cobra command definitions via just generate-cli-docs), see the CLI Reference section.