IF Commons GitHub

new library

verbmutate

Scaffold a library of commons: its folder, manifest, about.ts, specification kit, tools, tsconfig and LICENSE, and make what needs it again.

Program repoctl-releaser. 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
kindaction
effectmutate
idempotentfalse
audienceboth
tiercontributor
dryRuntrue
checkfalse
reachChannelslocal, mcp
reachReadOnlyfalse
reachNeedsTtyfalse
reachRunsAscaller
reachConfirmationnone

Operands

OperandMeaning
NAMEThe name of the library: lower-case letters, digits and hyphens, starting with a letter.

Options

OptionMeaningProperties
--summaryWhat the library is, in a sentence or two: its first sentence is its row in the README.type=value, required=true, standard=false, humanOnly=false, valueName=TEXT
--roleWhere the README puts it: foundation, pattern, program or standard.type=value, required=false, standard=false, humanOnly=false, valueName=ROLE, default=program
--jsonWrite one JSON document and nothing else for a person.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
--dry-runShow what would change and change nothing.type=flag, required=false, standard=true, humanOnly=false, negatable=false, default=false

Examples

repoctl new library widget --summary Widgets, made by the book.  # Scaffold the library widget in the libraries' folder with its manifest, spec kit, tools and LICENSE.
repoctl new library widget --summary Widgets. --dry-run  # List the files that would be made, and write nothing.

Physical: what it is drawn as

repoctl new library

cli-command. Scaffold a library of commons: its folder, manifest, about.ts, specification kit, tools, tsconfig and LICENSE, and make what needs it again.

PropertyValue
usagerepoctl new library
wordsnew, library
tiercontributor

repoctl_new_library

mcp-tool. Scaffold a library of commons: its folder, manifest, about.ts, specification kit, tools, tsconfig and LICENSE, and make what needs it again. (action, effect mutate.)

PropertyValue
titlerepoctl new library
toolNamerepoctl_new_library
readOnlyHintfalse
destructiveHintfalse
idempotentHintfalse
inputssummary, role, dryRun, NAME
requiredsummary, NAME
tiercontributor

Not drawn

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

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