`maqpna explain`

Document a MAQPNA resource or field

Synopsis#

maqpna explain KIND[.field.path] [--recursive] [-o table|json|yaml]

Like kubectl explain, with no cluster: the schemas are the CRDs this maqpna was built with. KIND is a kind, plural or short name; examples:

  maqpna explain toolpolicy.spec.rules.when
  maqpna explain agent --recursive

Flag	Type	Description	Default
`--recursive`	switch	print every nested field	none

The global flags (--context, -o, --no-color, ...) work with every command.

$ maqpna explain agent
$ maqpna explain agent.spec.tier
$ maqpna explain toolpolicy.spec.rules --recursive

Prints a table by default; -o json or -o yaml print the data, and --jq EXPR filters the JSON.

Code	Meaning
`0`	success
`1`	error (the message says what failed, with a hint when there is one)
`2`	usage error: unknown flag, missing argument or bad value; the synopsis is printed
`3`	a check failed, a change is blocked, or a result did not match (tamper, policy mismatch) (not used by this command)

maqpna explain.cast