IF Commons GitHub

ls

verbread

List what is in a directory of a store, or say what a file is.

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

Operands

OperandMeaning
LOCATIONA directory or a file: a path, a mount (name:/path) or an address (ssh://host/path). Here by default.

Options

OptionMeaningProperties
--longOne line for each name: mode, size, time, revision.type=flag, short=l, required=false, standard=false, humanOnly=false, negatable=false, default=false
--recursiveGo into directories.type=flag, short=R, required=false, standard=false, humanOnly=false, negatable=false, default=false
--humanSizes for a person (K, M, G).type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false
--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 ls fleet:/machines  # The names in the directory machines of the mount fleet.
anyfs ls -l ssh://alpha.example.org/srv/fleet  # The same with their sizes, times and revisions.

Physical: what it is drawn as

anyfs ls

cli-command. List what is in a directory of a store, or say what a file is.

PropertyValue
usageanyfs ls
wordsls
tierreader

anyfs_ls

mcp-tool. List what is in a directory of a store, or say what a file is. (report, effect read, safe to repeat.)

PropertyValue
titleanyfs ls
toolNameanyfs_ls
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputslong, recursive, human, explain, strict, LOCATION
requiredLOCATION
tierreader

GET /v1/ls

rest-route. List what is in a directory of a store, or say what a file is.

PropertyValue
methodGET
path/v1/ls
operationIdanyfs_ls
effectread
tierreader
idempotenttrue

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