IF Commons GitHub

tree

verbread

Draw the directories and files below a directory of a store.

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

Operands

OperandMeaning
LOCATIONA directory. Here by default.

Options

OptionMeaningProperties
--depthGo down at most N directories.type=value, short=L, required=false, standard=false, humanOnly=false, valueName=N
--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
--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 tree -L 2 fleet:/  # Two levels of the mount fleet, drawn.

Physical: what it is drawn as

anyfs tree

cli-command. Draw the directories and files below a directory of a store.

PropertyValue
usageanyfs tree
wordstree
tierreader

anyfs_tree

mcp-tool. Draw the directories and files below a directory of a store. (report, effect read, safe to repeat.)

PropertyValue
titleanyfs tree
toolNameanyfs_tree
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputsdepth, explain, strict, LOCATION
requiredLOCATION
tierreader

GET /v1/tree

rest-route. Draw the directories and files below a directory of a store.

PropertyValue
methodGET
path/v1/tree
operationIdanyfs_tree
effectread
tierreader
idempotenttrue

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