Skip to main content

osapi behavior

List, describe and validate the behaviors this binary has. osapi cli command get --name behavior shows the same.

Group​

Namebehavior
DescriptionList, describe and validate the behaviors this binary has

osapi behavior list​

Methodlist
DescriptionList the behaviors this binary has

osapi behavior get​

Methodget
DescriptionShow a behavior: its surfaces, chain, methods, types and telemetry
Refusesno name

Flags (1)​

FLAGTYPEVALIDATEHELP
--namestringrequiredThe behavior, from osapi behavior list

osapi behavior method get​

Methodmethod get
DescriptionShow one method of a behavior: its fields, constraints, output and examples
Refusesno name, no method

Flags (2)​

FLAGTYPEVALIDATEHELP
--namestringrequiredThe behavior, from osapi behavior list
--methodstringrequiredThe method, from osapi behavior get

osapi behavior create​

Methodcreate
DescriptionWrite a new behavior's standard layout in an osapi checkout
Refusesno name, no description

Flags (5)​

FLAGTYPEVALIDATEHELP
--namestringrequiredThe behavior's name: lowercase letters and digits
--descriptionstringrequiredWhat it manages, in one line
--groupstringomitemptyNest it under a group, such as network: its routes, commands and directory
--packagestringomitemptyThe Go package and directory, when it is not the name: package is a Go keyword, so --name package --package packages
--rootstringomitemptyThe osapi checkout to write into

osapi behavior spec get​

Methodspec get
DescriptionPrint the behavior DSL: each option, method, example part and field tag

osapi behavior validate​

Methodvalidate
DescriptionCheck every behavior against the rules the platform relies on