IF Commons GitHub

grep

verbread

Find lines that hold a text in files of a store, within a limit of files and bytes.

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
TEXTThe text to look for, as it is written: not a pattern.
LOCATIONFiles or directories (with -r) to look in.

Options

OptionMeaningProperties
--ignore-caseIgnore the case of letters.type=flag, short=i, required=false, standard=false, humanOnly=false, negatable=false, default=false
--line-numberWrite the number of each line.type=flag, short=n, required=false, standard=false, humanOnly=false, negatable=false, default=false
--files-with-matchesOnly the names of files that hold the text.type=flag, short=l, required=false, standard=false, humanOnly=false, negatable=false, default=false
--countOnly how many lines each file holds.type=flag, short=c, 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
--max-filesLook in at most N files (10000 by default).type=value, required=false, standard=false, humanOnly=false, valueName=N, default=10000
--max-bytesSkip files larger than N bytes (8 MiB by default).type=value, required=false, standard=false, humanOnly=false, valueName=N, default=8388608
--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 grep -rn ssh-ed25519 fleet:/keys  # Every line below keys that holds ssh-ed25519, with its number.

Physical: what it is drawn as

anyfs grep

cli-command. Find lines that hold a text in files of a store, within a limit of files and bytes.

PropertyValue
usageanyfs grep
wordsgrep
tierreader

anyfs_grep

mcp-tool. Find lines that hold a text in files of a store, within a limit of files and bytes. (report, effect read, safe to repeat.)

PropertyValue
titleanyfs grep
toolNameanyfs_grep
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputsignoreCase, lineNumber, filesWithMatches, count, recursive, maxFiles, maxBytes, explain, strict, TEXT, LOCATION
requiredTEXT, LOCATION
tierreader

GET /v1/grep

rest-route. Find lines that hold a text in files of a store, within a limit of files and bytes.

PropertyValue
methodGET
path/v1/grep
operationIdanyfs_grep
effectread
tierreader
idempotenttrue

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