ls
verbreadList 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.
| Property | Value |
|---|---|
kind | report |
effect | read |
idempotent | true |
audience | both |
tier | reader |
dryRun | false |
check | false |
reachChannels | local, ssh, mcp, rest |
reachReadOnly | true |
reachNeedsTty | false |
reachRunsAs | caller |
reachConfirmation | none |
Operands
| Operand | Meaning |
|---|---|
LOCATION | A directory or a file: a path, a mount (name:/path) or an address (ssh://host/path). Here by default. |
Options
| Option | Meaning | Properties |
|---|---|---|
--long | One line for each name: mode, size, time, revision. | type=flag, short=l, required=false, standard=false, humanOnly=false, negatable=false, default=false |
--recursive | Go into directories. | type=flag, short=R, required=false, standard=false, humanOnly=false, negatable=false, default=false |
--human | Sizes for a person (K, M, G). | type=flag, required=false, standard=false, humanOnly=false, negatable=false, default=false |
--explain | Say 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 |
--strict | Stop 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 |
--json | Write one JSON document and nothing else for a person. | type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false |
--sarif | Write the findings as SARIF 2.1.0 and nothing else. | 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 |
--on | Run 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.
| Property | Value |
|---|---|
usage | anyfs ls |
words | ls |
tier | reader |
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.)
| Property | Value |
|---|---|
title | anyfs ls |
toolName | anyfs_ls |
readOnlyHint | true |
destructiveHint | false |
idempotentHint | true |
inputs | long, recursive, human, explain, strict, LOCATION |
required | LOCATION |
tier | reader |
GET /v1/ls
rest-route. List what is in a directory of a store, or say what a file is.
| Property | Value |
|---|---|
method | GET |
path | /v1/ls |
operationId | anyfs_ls |
effect | read |
tier | reader |
idempotent | true |