DevTools Command Line - IBConsole
"IBConsole.exe", located in the Incredibuild installation folder, is a console application which initializes Incredibuild in various modes of operation, according to its various parameters. This chapter includes reference information on the command syntax and the available command parameters.
Syntax
The basic command line syntax for running a job through the Automatic Interception Interface is:
IBConsole.exe /command="<TOOL COMMAND>" /profile="<PROFILE XML>" [Command Line Options]
Note: IBConsole was formerly known as xgConsole. That command is also still supported with the same syntax.
Usage
The following syntax is used to operate IBConsole.exe:
IBConsole.exe /COMMAND="<job command line>" [options]OR
IBConsole.exe <Target> [Options]
Where:
-
/COMMAND can specify any command line, for use in conjunction with the Submission Interface or Automatic Interception Interface.
-
<Target> can specify one of the following: - A path to an .xml/.xpx file defining the distributed Job (for use in conjunction with the XML Interface) - A path to a .bat file (for use in conjunction with the Submission Interface or Automatic Interception Interface)
Working with Dev tools requires you to use IBConsole, and use of IBConsole with Dev tools requires you to use one of the three interfaces that Incredibuild offers in order to connect between the software or script that you want to accelerate and Incredibuild.
Note:
-
If when running IBConsole you get the error message: "'IBConsole' is not recognized as an internal or external command, operable program or batch file.", do one of the following:- Manually add the Incredibuild installation folder to your system path.- Rerun the Incredibuild setup application on your machine with the "Add Incredibuild folder to the system path" option selected.
Command Line Options
| Option | Function | Notes |
|---|---|---|
| @ | Specifies a response file containing an IBConsole command line. | Use this option when the command line for running IBConsole is too long to specify explicitly in your script. |
| /Attach | Displays the build output of either the current or last build. | If a build is currently running on the machine, this displays the output for the build up to that point, and continues displaying the process output until it ends. If no build is running, IBConsole displays the entire build output for the last build initiated from this machine. |
| /AvoidLocal=[On/Off] | Overrides the Avoid task execution on local machine when possible option in the Agent Settings dialog box. | A value (either ON or OFF) is mandatory. |
| /Beep | Plays a sound when the process is complete. | |
| /Disable | Disables Incredibuild Agent to participate as a Helper. | |
| /Enable | Enables Incredibuild Agent to participate as a Helper. | |
| /Help | Shows usage help and version information. | |
| /Log[=filename] | Writes process output to a file. | If a filename is not specified, a file named IB_<target-name>.log is created in the current directory. |
| /LogLevel="<Level>" | Overrides the logging level for this build. | "<Level>" can be one of the following: Minimal, Basic, Intermediate, Extended, Detailed |
| /MaxCPUS=<n> | Overrides the global maximum CPUs/Cores in the build setting. | |
| /MaxWinVer="<Version>" | Specifies the maximal operating system required by remote Agents assigned to this build. | Agents with a newer OS will not be assigned to the build. Available values are: XP, 2003, VISTA, 2008, 7, 8, and 10. |
| /MinWinVer="<Version>" | Specifies the minimal required operating system required by remote Agents assigned to this build. | Agents with an older OS will not be assigned to the build. Available values are: XP, 2003, VISTA, 2008, 7, 8, and 10. |
| /Mon[=filename] | Writes a copy of the build progress (.ib_mon) file to the specified location. |
- If only a folder name is given, Incredibuild generates a GUID for the file name. - A message containing the location of the saved .ib_mon file is added to the end of the process output. |
| /NO_DOTNET_VIRT | Disables the Virtualization of .NET environment on Helper machines. | When this switch is specified in the command line, it instructs Incredibuild not to virtualize the .NET environment of the Initiator machine to the Helper machines. This switch was added to address .NET incompatibilities in a mixed OS environment. |
| /NoLogo | Suppresses the "Incredibuild" header in the build output. | |
| /NoWait | When specified, if another process initiated by this Agent is already running, IBConsole exits with an "Another build already running" message. | |
| /OpenMonitor | Opens the Build Monitor window that shows the execution progress. | |
| /out=filename | Redirects the entire command line output to a file. | |
| /QueryLicense | Displays information regarding the active license, allocated packages, and maintenance expiration date. | |
| /QueryPackage="<Package>" | Checks whether a specific Incredibuild extension package is allocated to the Agent, and sets the exit code to 0 (allocated) or 1 (not allocated). | "<Package>" can be either "VC", "C#", "BuildTools", "DevToolAcc", "XGE", "Xbox One", "PlayStation", "Cafe", "3DS", "KlocWorkPro" or "Coverity". In addition, the following cores packages are supported: "4Cores", "8Cores", "12Cores", "16Cores", "24Cores", "32Cores", "48Cores" and "64Cores". |
| /Reset | Clears the Agent's file cache content. | |
| /SetEnv="<name>=<value>" | Sets or overrides environment variables for the context of the command execution. | Use /SetEnv several times to set/override multiple variables. |
| /ShowAgent | Shows the Agent used for each task execution. | |
| /ShowCmd | Shows for each executed task, the command-line used by Incredibuild to execute the task. | For XML Interface only. |
| /ShowTime | Shows the Start and Finish time for each task. | |
| /Silent | Does not write anything to the standard output. | Default behavior is to write the build results, as seen in the Build Monitor's Output display. |
| /Stop[=<build-id>] | Stops a currently running build on the local machine. Provide <build-id> if more than one build is running. | IBConsole returns the code 3 when a build has been stopped. If /stop was used and no build is currently running, code 2 is returned. |
| /StopOnErrors | When specified, the execution will stop as soon as an error is encountered. | |
|
/StopAll |
Stops all currently running builds |
|
| /Title=<build title> | Specifies a custom header line which will be displayed in the beginning of the Execution output text. This title will also be used for the Execution History and Execution Monitor displays. | Value may be surrounded by quotes. |
| /UseIDEMonitor | When IBConsole is run from the Visual Studio IDE with this option, the integrated IDE Execution Monitor displays the execution progress. | |
| /Wait | If another process initiated by this Agent is currently running, waits until that process is finished and then starts the new process. This is also the default behavior. |
Return Codes
IBConsole returns the following return codes:
0 - No errors were encountered.1 - Errors were encountered during the operation.2 - A fatal Incredibuild error was encountered (invalid parameters, input file not found, etc.).3 - The operation was stopped before completing.
Note:
-
Only one IBConsole execution can run on a single machine at any given moment. Therefore, a pause occurs between the time that a currently running build is completed and a new one begins to run.
Interface-Specific Usage and Examples
For examples and specific information regarding using IBConsole.exe to activate the different IB Interfaces, see the following sections: