Command Line Options
The following table describes the IBConsole.exe 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. |
/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. | |
/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. |
/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. |
/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. | |
/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. |
/Silent | Does not write anything to the standard output. | Default behavior is to write the Execution results, as seen in the Execution Monitor's Output display. |
/Stop | Stops a currently running process/task on the local machine. | IBConsole returns the code 3 when an Execution has been stopped. If /stop was used and no build is currently running, code 2 is returned. |
/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. |
/ShowCmd | Shows for each executed task, the command-line used by IncrediBuild to execute the task(XML Interface only). | |
/ShowAgent | Shows the Agent used for each task execution. | |
/ShowTime | Shows the Start and Finish time for each task. | |
/OpenMonitor | Opens the Execution Monitor window showing the execution progress. | |
/UseIDEMonitor | When IBConsole is run from the Visual Studio IDE with this option, the integrated IDE Execution Monitor displays the execution progress. | |
/MaxCPUS=<n> | Overrides global max. CPUs/Cores in build setting. | |
/AvoidLocal=[On/Off] | Overrides the Agent Settings dialog Avoid task execution on local machine when possible option. | A value (either ON or OFF) is mandatory. |
/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 Execution. 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 Execution. Available values are: XP, 2003, VISTA, 2008, 7, 8 and 10. |
/StopOnErrors | When specified, the execution will stop as soon as an error is encountered. | |
/LogLevel="<Level>" | Overrides the logging level for this Execution. | "<Level>" can be one of the following: Minimal, Basic, Intermediate, Extended, Detailed |
/Help | Shows usage help and version information. | |
/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. |
/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 execution is completed and a new one begins to run.
DevTools Solution:
Integration Interfaces
DevTools Command Line - IBConsole
IBConsole Command Line Options
Further Build Performance Optimizations
IncrediBuild Solutions:
Visual Studio Solution
Make and Other Build Tools Solution
DevTools Solution
IncrediBuild for Qt Creator
IncrediBuild For Game Development
IncrediBuild for Unit Tests
Working with Build Groups
Running Gitlab Builds with Incredibuild
User Manual:
List of Open Sources
Getting Started
Set Up and Installation
IncrediBuild Solutions
The Coordinator
IncrediBuild Agents
IncrediBuild Cloud
Working from Home
Troubleshooting Issues
IncrediBuild Additional Resources
Release Notes