Skip to main content

osapi cli command

List, describe and validate the local commands, and print their DSL. osapi cli command get --name cli command shows the same.

Group​

Namecli command
DescriptionList, describe and validate the local commands, and print their DSL

osapi cli command list​

Methodlist
DescriptionList each command of this binary, and the layer that made it

osapi cli command get​

Methodget
DescriptionDescribe one group: its commands, and the flags and refusals of a local group
Refusesno name

Flags (1)​

FLAGTYPEVALIDATEHELP
--namestringrequiredThe command path of the group, such as token or agent

osapi cli command create​

Methodcreate
DescriptionWrite a new local group that builds and passes its tests
Refusesno name, no description

Flags (2)​

FLAGTYPEVALIDATEHELP
--namestringrequiredThe group's name: its command under osapi
--descriptionstringrequiredWhat the group is, in one line

osapi cli command spec get​

Methodspec get
DescriptionPrint the command DSL: each option, method, refinement, field tag and check

osapi cli command validate​

Methodvalidate
DescriptionCheck every local group against the rules of a definition, and the output of every group