IF Commons GitHub

rm

verbdestructive

Remove files, or directories and everything below them with -r.

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

Operands

OperandMeaning
LOCATIONFiles, or directories with -r.

Options

OptionMeaningProperties
--recursiveRemove directories and everything below them.type=flag, short=r, required=false, standard=false, humanOnly=false, negatable=false, default=false
--forceNo error where a name is not there.type=flag, short=f, required=false, standard=false, humanOnly=false, negatable=false, default=false
--plan-hashRemove only what the plan with this hash lists, which --dry-run printed: if the names changed since, nothing is removed.type=value, required=false, standard=false, humanOnly=false, valueName=HASH
--explainSay how the store would carry the operation out (native, emulated or refused), and do nothing else.type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--strictStop where the store carries an operation out by a means that can lose or change what you meant.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
--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 rm -r --dry-run fleet:/retired  # The names that would go, and the hash of that list.
anyfs rm -r --yes --plan-hash <hash> fleet:/retired  # Remove exactly that list.

Physical: what it is drawn as

Not drawn by any surface for this tier.

Not drawn

  • cli: rm is for the tier writer; this caller holds reader
  • mcp: rm is for the tier writer; this caller holds reader
  • rest: rm is for the tier writer; this caller holds reader

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