IF Commons GitHub

query

verbread

Ask the libraries, their specifications and their requirements in SQL: one read-only SELECT over the relations libraries, specs and requirements.

Program repoctl-public. 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

Operands

OperandMeaning
SQLOne SELECT over libraries, specs and requirements.

Options

OptionMeaningProperties
--limitThe most rows of the answer.type=value, required=false, standard=false, humanOnly=false, valueName=N, default=1000
--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 query SELECT library, count(*) AS n FROM requirements WHERE mechanism = 'none' GROUP BY library  # Count the requirements that nothing verifies, library by library.
repoctl query SELECT name, version FROM libraries ORDER BY name --json  # The libraries with their versions, as one JSON document.

Physical: what it is drawn as

repoctl query

cli-command. Ask the libraries, their specifications and their requirements in SQL: one read-only SELECT over the relations libraries, specs and requirements.

PropertyValue
usagerepoctl query
wordsquery
tierpublic

repoctl_query

mcp-tool. Ask the libraries, their specifications and their requirements in SQL: one read-only SELECT over the relations libraries, specs and requirements. (report, effect read, safe to repeat.)

PropertyValue
titlerepoctl query
toolNamerepoctl_query
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
inputslimit, SQL
requiredSQL
tierpublic

Not drawn

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

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