Skip to content

conv (alias)

opnDossier conv

Alias for 'convert' command

Synopsis

Alias for the 'convert' command. Converts OPNsense or pfSense configuration files to structured formats.

opnDossier conv [file ...] [flags]

Options

      --comprehensive      Generate comprehensive detailed reports with full configuration analysis
      --force              Force overwrite existing files without prompting for confirmation
  -f, --format string      Output format for conversion (markdown, json, yaml, text, html) (default "markdown")
  -h, --help               help for conv
      --include-tunables   Include all system tunables in report output (markdown, text, HTML only; JSON/YAML always include all tunables)
      --no-wrap            Disable text wrapping (alias for --wrap 0)
  -o, --output string      Output file path for saving converted configuration (default: print to console)
      --redact             Redact sensitive fields (passwords, keys, community strings) in output
      --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)

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)

SEE ALSO

  • opnDossier - opnDossier: A CLI tool for processing OPNsense and pfSense configuration files.
Auto generated by spf13/cobra on 20-Apr-2026