IF Commons GitHub

roster show

verbread

Say each key of a roster file, the replica it speaks for and whether it speaks now.

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
ROSTERThe file of the roster.

Options

OptionMeaningProperties
--atThe instant to judge the keys at; now where it is left out.type=value, required=false, standard=false, humanOnly=false, valueName=MS
--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 roster show roster.json  # Each key with the replica it speaks for and whether it speaks now.

Physical: what it is drawn as

anyfs roster show

cli-command. Say each key of a roster file, the replica it speaks for and whether it speaks now.

PropertyValue
usageanyfs roster show
wordsroster, show
tierreader

anyfs_roster_show

mcp-tool. Say each key of a roster file, the replica it speaks for and whether it speaks now. (report, effect read, safe to repeat.)

PropertyValue
titleanyfs roster show
toolNameanyfs_roster_show
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputsat, ROSTER
requiredROSTER
tierreader

GET /v1/roster/show

rest-route. Say each key of a roster file, the replica it speaks for and whether it speaks now.

PropertyValue
methodGET
path/v1/roster/show
operationIdanyfs_roster_show
effectread
tierreader
idempotenttrue

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