30-second answer

One command line, installed under two names, m365g and m365-governance. Its commands split into three jobs: reaching a tenant and writing down what was seen, deciding what the evidence means, and handing the result to somebody who does not have this engine.

Two names, one command line. From 1.0.0b10 the package installs m365g beside the earlier name, and the commands are grouped by service as well: m365g spo site list is m365-governance collect sites by another name. Everything on these pages can be typed after either name, and every earlier command still works. The grouped commands, signing in once, and the composed inspections are documented in the command line.

The commands this manual documents

The top-level help of 1.0.0b10 opens with the session commands and the groups by service, and ends by saying that the earlier flat names still work:

Text
usage: m365-governance [--version] COMMAND ...

These pages document the flat names, one page each. Every one of them is a command the published parser registers.

CommandWhat it does
setupFrom an empty machine to a first report: what this machine needs, and the app registration
connectAsk the tenant whether this identity signs in, and what it may read
runFrom a configured target to a report
collectRun a collector against a tenant and write evidence. Evaluates nothing
statsWhat a collector managed to see, before evaluating it
evaluateRun rules against an evidence document
assessEvaluate evidence and write an assessment that can be handed over
explainWhat an outcome means, and what it does not
reportRe-render a stored report, without evaluating anything
diffWhat changed between two assessments, and what it does not say
list-rulesEvery rule, with the kind of claim it makes
show-ruleOne rule in full, including what it does not establish
validateCheck every rule against the schemas and the invariants
capabilitiesWhat this engine can answer, and how far each answer is proved
doctorWhat is wrong with this installation, before you ask
verifyCheck an assessment that arrived, without the engine that made it
contractsWrite the contract bundle a consumer vendors
migration-readRecord what an estate held, before a migration moves it
migration-verifyCompare a read before with a read after, and say what arrived

What holds across all of them

Collection never writes. A collector has no write path to the tenant. When collection fails, the failure message says so explicitly, because the first question anybody asks about a failed run against production is what it left behind.

Rules come from the installed version unless you say otherwise. Every command that reads rules takes --rules, and the help text is precise about what that does: supplying a directory replaces the packaged rules entirely rather than adding to them.

Exit codes carry meaning. 0 succeeded. 2 means the engine refused: an argument was missing, a document was not what the command expects, or the inputs would have produced a claim the evidence does not support. 1 means the command ran and the result was negative: rules failed under --fail-on, an assessment did not verify, doctor found something wrong, or collection failed. See exit codes.

Nothing reads the clock except where it must. assess takes --created-at, so the same inputs rebuild the same bytes. An assessment whose digest moved because time passed would be unverifiable by construction.

The path through them

Text
collect  ->  stats  ->  evaluate  ->  assess  ->  diff
                                        |
                                        v
                                      verify

collect reaches the tenant. stats says what it managed to see before you read any conclusion. evaluate produces a report for you. assess produces a document for somebody else, and verify is what that somebody else runs.