IF Commons GitHub

usage

verbread

Say what this repository uses of the package @intellectual-frontiers/commons: the libraries it imports, those reached through them and those never touched, with their sizes.

Program repoctl-contributor. Origin repoctl.

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
tierpublic
dryRunfalse
checkfalse
reachChannelslocal, mcp
reachReadOnlytrue
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Options

OptionMeaningProperties
--rootThe repository to read (the repository repoctl runs in by default).type=value, required=false, standard=false, humanOnly=false, valueName=DIR
--packageThe folder of the installed package (node_modules/@intellectual-frontiers/commons of the repository by default).type=value, required=false, standard=false, humanOnly=false, valueName=DIR
--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

Examples

repoctl usage  # What this repository uses of the package: the libraries imported, those reached through them and those never touched.
repoctl usage --root ../erga --package ../erga/node_modules/@intellectual-frontiers/commons --json  # The same for another repository, as one JSON document.

Physical: what it is drawn as

repoctl usage

cli-command. Say what this repository uses of the package @intellectual-frontiers/commons: the libraries it imports, those reached through them and those never touched, with their sizes.

PropertyValue
usagerepoctl usage
wordsusage
tierpublic

repoctl_usage

mcp-tool. Say what this repository uses of the package @intellectual-frontiers/commons: the libraries it imports, those reached through them and those never touched, with their sizes. (report, effect read, safe to repeat.)

PropertyValue
titlerepoctl usage
toolNamerepoctl_usage
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputsroot, package
tierpublic

Not drawn

  • rest: its reach policy does not name the rest channel

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