opnDossier#

opnDossier: A CLI tool for processing OPNsense and pfSense configuration files.

Synopsis#

opnDossier is a command-line interface (CLI) tool designed to process OPNsense
and pfSense firewall configuration files (config.xml) and convert them into
human-readable formats, primarily Markdown. This tool is built to assist network
administrators and security professionals in documenting, auditing, and
understanding their firewall configurations more effectively.

WORKFLOW EXAMPLES:

Basic conversion workflow#

opnDossier convert config.xml -o documentation.md

Development workflow with verbose logging#

opnDossier --verbose convert config.xml --format json

Generate comprehensive report#

opnDossier convert config.xml --comprehensive

Validation workflow#

opnDossier validate config.xml && opnDossier convert config.xml -o documentation.md

Options#

      --color string Color output mode (auto, always, never) (default "auto")
      --config string Configuration file path (default: $HOME/.opnDossier.yaml)
      --debug Enable debug-level logging (all messages, for troubleshooting)
      --device-type string Force device type (supported: opnsense, pfsense). Bypasses auto-detection.
  -h, --help help for opnDossier
      --minimal Minimal output mode (suppresses progress and verbose messages)
      --no-progress Disable progress indicators
  -q, --quiet Suppress all output except errors and critical messages
      --timestamps Include timestamps in log output
  -v, --verbose Enable info-level logging (warnings, errors, and informational messages)