IF Commons GitHub

prove

verbread

Compute the proof a change needs from its blast radius (the tiers, the tests and why each skipped proof is safe) and run it.

Program repoctl-public. Origin repoctl.

Governance: the action

What the verb is and may do, as governance says it. Each annotation is expressed by the surfaces or says why it is not.

PropertyValue
kindreport
effectread
idempotenttrue
audienceboth
tierpublic
dryRunfalse
checkfalse
reachChannelslocal, mcp
reachReadOnlytrue
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Options

OptionMeaningProperties
--baseThe revision the change starts at (origin/main, else main, else HEAD).type=value, required=false, standard=false, humanOnly=false, valueName=REF
--planPrint the plan as one JSON document and run nothing.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--whySay, for every proof and every proof left out, why.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--tierRun only this tier (0 to 6 or T0 to T6).type=value, required=false, standard=false, humanOnly=false, valueName=N
--allPlan every proof of every tier, whatever changed.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--no-cacheRun every selected test, whatever the cache holds.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--jsonWrite one JSON document and nothing else for a person.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--sarifWrite the findings as SARIF 2.1.0 and nothing else.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--quietShow only how it ended.type=flag, short=q, required=false, standard=true, humanOnly=false, negatable=false, default=false
--verboseShow every step as it happens.type=flag, short=v, required=false, standard=true, humanOnly=false, negatable=false, default=false
--colorUse colour where the terminal shows it (--no-color turns it off).type=flag, required=false, standard=true, humanOnly=false, negatable=true, default=true
--non-interactiveNever ask a question: where one is needed, fail and say so.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false

Examples

repoctl prove  # Prove what the working tree changes since origin/main: the tiers T0 to T3 that apply, and only those.
repoctl prove --why  # The same, with the sentence that says why each proof runs and why each skipped proof is safe to skip.
repoctl prove --plan  # The plan as JSON, run nothing: what CI and the development loop read.
repoctl prove --tier 0  # Only the static proofs of the plan.
repoctl prove --all --plan  # Every proof of every tier, as the nightly run and the release plan it.

Physical: what it is drawn as

repoctl prove

cli-command. Compute the proof a change needs from its blast radius (the tiers, the tests and why each skipped proof is safe) and run it.

PropertyValue
usagerepoctl prove
wordsprove
tierpublic

repoctl_prove

mcp-tool. Compute the proof a change needs from its blast radius (the tiers, the tests and why each skipped proof is safe) and run it. (report, effect read, safe to repeat.)

PropertyValue
titlerepoctl prove
toolNamerepoctl_prove
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputsbase, plan, why, tier, all, noCache
tierpublic

Not drawn

  • rest: its reach policy does not name the rest channel

Titles, headings, exports, tables, columns and requirements. Esc closes.