display

opnDossier display¶

Display OPNsense configuration in formatted markdown.

Synopsis¶

The 'display' command converts an OPNsense config.xml file to markdown and renders it in the terminal with syntax highlighting via glamour. Use display for a quick, interactive read of a configuration without producing any files.

Display parses the configuration without strict validation so that it remains usable on real-world configs that contain minor inconsistencies. Use the 'validate' command when full structural validation is required.

RENDERING: - Syntax-highlighted markdown with headers, lists, and code blocks - Theme-aware colors that adapt to light/dark terminals - Structured presentation of the configuration hierarchy

CONTENT CONTROL: --theme Force theme (light|dark|auto|none) --section Restrict output to specific sections (e.g. system,firewall) --wrap N Wrap text at N columns (auto-detected if omitted) --no-wrap Disable text wrapping (equivalent to --wrap 0) --redact Redact passwords, SNMP community strings, private keys --comprehensive Include all sections, even rarely used ones --include-tunables Include all system tunables (including defaults)

RELATED: convert - Produce a file artifact instead of terminal output validate - Validate config.xml structure before displaying audit - Layer compliance checks on top of the rendered report

opnDossier display [file] [flags]

Examples¶

  # Display configuration with auto-detected theme and width
  opnDossier display config.xml

  # Force a specific theme
  opnDossier display --theme dark config.xml

  # Restrict output to specific sections
  opnDossier display --section system,network config.xml

  # Wrap at a specific column width
  opnDossier display --wrap 100 config.xml

  # Disable text wrapping
  opnDossier display --no-wrap config.xml

  # Redact sensitive fields from the rendered output
  opnDossier display --redact config.xml

  # Verbose logging for troubleshooting
  opnDossier --verbose display config.xml

Options¶

      --include-tunables   Include all system tunables in report output (markdown, text, HTML only; JSON/YAML always include all tunables)
      --section strings    Specific sections to include in output (comma-separated, e.g., system,network,firewall)
      --wrap int           Text wrap width in characters (-1 = auto-detect terminal width, 0 = no wrapping, recommended: 80-120) (default -1)
      --no-wrap            Disable text wrapping (alias for --wrap 0)
      --comprehensive      Generate comprehensive detailed reports with full configuration analysis
      --theme string       Theme for rendering output (light, dark, auto, none)
      --redact             Redact sensitive fields (passwords, keys, community strings) in output
  -h, --help               help for display

Options inherited from parent commands¶

      --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.
      --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)