IF Commons GitHub

mirror sync

verbdestructive

Bring a replica to its primary, never touching what the replica changed itself.

Program anyfs-writer. 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
kindaction
effectdestructive
idempotentfalse
audienceboth
tierwriter
dryRuntrue
checkfalse
reachChannelslocal, mcp
reachReadOnlyfalse
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationflag

Operands

OperandMeaning
PRIMARYThe directory that is the source of truth.
REPLICAThe directory that follows it.

Options

OptionMeaningProperties
--max-deletesAllow at most N deletes at the replica: none without it.type=value, required=false, standard=false, humanOnly=false, valueName=N
--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
--plan-hashApply only the plan with this hash, which a --dry-run printed: if the stores changed since, nothing is applied.type=value, required=false, standard=false, humanOnly=false, valueName=HASH
--jsonWrite one JSON document and nothing else for a person.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
--dry-runShow what would change and change nothing.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false
--yesConfirm the destruction without asking.type=flag, short=y, required=false, standard=true, humanOnly=false, negatable=false, default=false

Examples

anyfs mirror sync --dry-run fleet:/ s3backup:/fleet  # How far behind the replica is, and the hash of that state.
anyfs mirror sync --yes --plan-hash <hash> fleet:/ s3backup:/fleet  # Bring it up; what the replica changed itself is never touched.

Physical: what it is drawn as

anyfs mirror sync

cli-command. Bring a replica to its primary, never touching what the replica changed itself.

PropertyValue
usageanyfs mirror sync
wordsmirror, sync
tierwriter

anyfs_mirror_sync

mcp-tool. Bring a replica to its primary, never touching what the replica changed itself. (action, effect destructive.)

PropertyValue
titleanyfs mirror sync
toolNameanyfs_mirror_sync
readOnlyHintfalse
destructiveHinttrue
idempotentHintfalse
inputsmaxDeletes, include, exclude, planHash, dryRun, PRIMARY, REPLICA
requiredPRIMARY, REPLICA
tierwriter

Not drawn

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

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