Commands

The following tables describe command properties that you can include in a devfile:

commandObject

Key Type Required Description
execexecObjectnoThe exec command to run.
compositecompositeObjectnoThe composite command to run.

execObject

Key Type Required Description
idstringyesThe ID of the command.
commandLinestringyesThe command to run.
componentstringnoThe component to which the action relates.
labelstringnoThe optional label to describe the command.
workingDirstringnoThe working directory where you run the command.
groupgroupObjectnoThe group to which the command belongs.
environmentenvObjectnoThe list of environment variables you use.

compositeObject

Key Type Required Description
idstringyesThe ID of the command.
commandsstringnoThe exec commands that constitute the composite command that chains multiple commands together.
parallelbooleannoThe flag that indicates if commands are run in parallel.
labelstringnoThe optional label to describe the command.
groupgroupObjectnoThe group to which the composite command belongs. The composite command cannot be of the run kind.

groupObject

Key Type Required Description
kindstringyesThe group to which the command belongs, such as: build, run, test, and debug.
isDefaultbooleannoIdentifies whether it is the default command to run. Only one default command can be defined for each group.