oz0 plugin explain
For: Operators and developers looking up a command.
Writes four files into --out: diagram.svg (the plugin's graph, laid out as the studio draws it, legible printed in black and white), diagram.mmd (the same graph as a Mermaid flowchart), summary.html (one printable page: what the plugin and each flow do, the steps, approvals, the tool-policy rules that apply with their IDs, data rules, purposes and legal bases, recipients, budgets, the coverage figure when the files hold a coverage report, the version and digests) and explain.json (the same facts as data).
Print the page to PDF from a browser. The same files and settings give the same bytes, so two exports diff cleanly. The tenant's tool policy and data rules are included when you hold governance.read, its purposes, legal bases and recipients when you hold inventory.read; the page says what was left out. Each export is audited. The page describes what the files and settings state; it is not an assessment.
With a name, the installed version in the tenant; with --dir, a local plugin folder, read without a server and without the tenant's settings.
Usage
oz0 plugin explain [<name>] --out <dir> [flags]
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
--coverage | string | with --dir: a coverage report (plugin test --coverage-out) instead of the folder's evals/coverage.json | |
--dir | string | a local plugin folder to explain instead of an installed plugin | |
--flow | string | keep one flow, its steps and what they run | |
--out | string | the folder to write diagram.svg, diagram.mmd, summary.html and explain.json into | |
--tenant | string | default | the tenant |
Inherited flags
| Flag | Type | Default | Description |
|---|---|---|---|
--context | string | $OZ0_CONTEXT or <config dir>/orchestrator-zero/context.json | CLI context file written by server init |
--log-level | string | info | log level: debug, info, warn or error |
See all oz0 commands and the global flags.