sync
verbdestructiveMake a destination equal to a source: a plan first with its hash, then the apply that the hash approves.
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.
| Property | Value |
|---|---|
kind | action |
effect | destructive |
idempotent | false |
audience | both |
tier | writer |
dryRun | true |
check | false |
reachChannels | local, mcp |
reachReadOnly | false |
reachNeedsTty | false |
reachRunsAs | caller |
reachConfirmation | flag |
Operands
| Operand | Meaning |
|---|---|
SOURCE | The directory to copy from. |
DEST | The directory to make equal to it. |
Options
| Option | Meaning | Properties |
|---|---|---|
--max-deletes | Allow the plan to delete at most N files at the destination: none without it. | type=value, required=false, standard=false, humanOnly=false, valueName=N |
--include | Only 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 |
--exclude | Leave out paths that match a glob; give it again for more. | type=many, required=false, standard=false, humanOnly=false, valueName=GLOB |
--max-files | Refuse a plan that writes more than N files. | type=value, required=false, standard=false, humanOnly=false, valueName=N |
--max-bytes | Refuse a plan that writes more than N bytes. | type=value, required=false, standard=false, humanOnly=false, valueName=N |
--lossless | Refuse a plan that would lose anything at the destination (a name it cannot keep, a case that folds). | type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false |
--concurrency | At most N actions at once (the configuration's by default). | type=value, required=false, standard=false, humanOnly=false, valueName=N |
--plan-hash | Apply 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 |
--json | Write one JSON document and nothing else for a person. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--quiet | Show only how it ended. | type=flag, short=q, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--verbose | Show every step as it happens. | type=flag, short=v, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--color | Use colour where the terminal shows it (--no-color turns it off). | type=flag, required=false, standard=true, humanOnly=false, negatable=true, default=true |
--non-interactive | Never ask a question: where one is needed, fail and say so. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--dry-run | Show what would change and change nothing. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--yes | Confirm the destruction without asking. | type=flag, short=y, required=false, standard=true, humanOnly=false, negatable=false, default=false |
Examples
anyfs sync --dry-run ./fleet s3backup:/fleet # The plan: what would be created, updated and (with --max-deletes) deleted, and its hash.
anyfs sync --yes --plan-hash <hash> ./fleet s3backup:/fleet # Apply exactly that plan.Physical: what it is drawn as
Not drawn by any surface for this tier.
Not drawn
- cli: sync is for the tier writer; this caller holds reader
- mcp: sync is for the tier writer; this caller holds reader
- rest: sync is for the tier writer; this caller holds reader