IF Commons GitHub

bisync

verbdestructive

Make two directories equal both ways against a recorded base, with a rule for what both changed.

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
AThe first directory.
BThe second directory.

Options

OptionMeaningProperties
--conflictWhat to do with a path both sides changed: fail, newer-wins or keep-both.type=value, required=false, standard=false, humanOnly=false, valueName=RULE, default=fail
--seedThe first run: take the union of the two sides as the base. Needed once, and only where no base is recorded.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--max-deletesLet a delete on one side reach the other, at most N: 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
--concurrencyAt most N actions at once (the configuration's by default).type=value, required=false, standard=false, humanOnly=false, valueName=N
--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 bisync --seed --dry-run ./fleet s3backup:/fleet  # The first run's plan: the union of both sides is the base.
anyfs bisync --conflict keep-both --dry-run ./fleet s3backup:/fleet  # Later runs: only what changed since the base.

Physical: what it is drawn as

anyfs bisync

cli-command. Make two directories equal both ways against a recorded base, with a rule for what both changed.

PropertyValue
usageanyfs bisync
wordsbisync
tierwriter

anyfs_bisync

mcp-tool. Make two directories equal both ways against a recorded base, with a rule for what both changed. (action, effect destructive.)

PropertyValue
titleanyfs bisync
toolNameanyfs_bisync
readOnlyHintfalse
destructiveHinttrue
idempotentHintfalse
inputsconflict, seed, maxDeletes, include, exclude, concurrency, planHash, dryRun, A, B
requiredA, B
tierwriter

Not drawn

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

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