IF Commons GitHub

check

verbread

Compare two directories by content and say what differs; changes nothing.

Program anyfs-reader. Origin anyfs.

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
tierreader
dryRunfalse
checkfalse
reachChannelslocal, ssh, mcp, rest
reachReadOnlytrue
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Operands

OperandMeaning
AThe first directory.
BThe second directory.

Options

OptionMeaningProperties
--includeOnly paths that match a glob (a * is within one name, ** crosses directories); give it again for more.type=many, required=false, standard=false, humanOnly=false, valueName=GLOB
--excludeLeave out paths that match a glob; give it again for more.type=many, required=false, standard=false, humanOnly=false, valueName=GLOB
--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
--onRun it on these targets instead of here: ids joined by commas, `class:<class>` or `all`.type=value, required=false, standard=true, humanOnly=false, valueName=VALUE

Examples

anyfs check ./fleet s3backup:/fleet  # Whether the two hold the same files with the same content; nothing is changed.

Physical: what it is drawn as

anyfs check

cli-command. Compare two directories by content and say what differs; changes nothing.

PropertyValue
usageanyfs check
wordscheck
tierreader

anyfs_check

mcp-tool. Compare two directories by content and say what differs; changes nothing. (report, effect read, safe to repeat.)

PropertyValue
titleanyfs check
toolNameanyfs_check
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputsinclude, exclude, A, B
requiredA, B
tierreader

GET /v1/check

rest-route. Compare two directories by content and say what differs; changes nothing.

PropertyValue
methodGET
path/v1/check
operationIdanyfs_check
effectread
tierreader
idempotenttrue

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