opnDossier_list_plugins

opnDossier list plugins#

List available compliance plugins

Synopsis#

List the compliance plugins the running opnDossier binary supports.

Built-in plugins (such as STIG, SANS, and firewall) are always listed. To
include dynamically-loaded .so plugins, pass --plugin-dir pointing at the
directory containing them; that flag triggers the same trust-model warning
and preflight checks that the audit command applies.

By default the command writes one plugin name per line — text mode is safe
to pipe directly into --plugins because only successfully-registered plugins
appear. Use --json to emit a structured array of
{name, description, version, status?, loadError?} objects. The status field
is omitted entirely for normal entries; when present it carries one of
"panicked", "lookup-failed", "load-failed", or "version-filled" so JSON
consumers can detect failure modes without scraping stderr. Dynamic plugin
load failures also surface as WARN lines on stderr in both text and JSON
modes.

opnDossier list plugins [flags]

Examples#

  # Plain text, one plugin name per line
  opnDossier list plugins

  # JSON output for automation
  opnDossier list plugins --json

  # Include dynamic plugins from a directory
  opnDossier list plugins --plugin-dir ./plugins --json

Options#

  -h, --help help for plugins
      --json Emit a JSON array of {name, description, version, status?, loadError?} objects
      --plugin-dir string Directory containing third-party .so compliance plugins (does not affect built-in stig/sans/firewall). Plugins run with full process privileges; signatures are not verified. Do not point at untrusted-writable directories. Linux/macOS/FreeBSD only; no-op on Windows. See GOTCHAS §2.5 and docs/user-guide/commands/audit.md § Third-Party Plugin Security.

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)