BuildMaster Documentation

General - Execute Shell Script

  • Last Modified: 2020-06-26

This is generated from the built-in components of BuildMaster 6.2.13, and may be different than what you have installed (especially if you have extensions); go to [User Icon] > Documentation within your BuildMaster instance to see exactly what operations are available.

Execute Shell Script

Executes a specified shell script.

Script usage:

SHExec(
	Text: <text>,
	[Verbose: <true/false>],
	[OutputLogLevel: <integer>],
	[ErrorOutputLogLevel: <integer>],
	[SuccessExitCode: <text>]
);

This operation may be prefixed with Linux::, although this is a built-in namespace and isn't really necessary.

Arguments:

Name Format Script Usage Usage Notes
Text (default)
text
Text
The shell script text. This argument is required.
Verbose
true/false
Verbose
When true, additional information about staging the script is written to the debug log.
Output log level
integer
OutputLogLevel
Error log level
integer
ErrorOutputLogLevel
Success exit code
text
SuccessExitCode
Integer exit code which indicates no error. When not specified, the exit code is ignored. This can also be an integer prefixed with an inequality operator.

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit ced119d5 on master