| @ | Specifies a response file containing a BuildConsole /command command line. | Use this option when the command line for running BuildConsole /command 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 build’s output until it ends. If no build is running, the BuildConsole/command displays the entire build output for the last build initiated from this machine. |
| /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. |
| /Beep | Plays a sound when the build is complete. | |
| /buildcachecluster=[cluster_name] | Use a build cache cluster from one defined in the Agent settings. The cluster (buildcachecluster) and single endpoint (buildcacheremoteserver) options are mutually exclusive.
This command-line switch only overrides the specified setting, without implicitly modifying or affecting other options that are not explicitly specified in the command line. | |
| /buildcachelocal=[ON|OFF] | Override the setting that defines if local Build Cache is enabled on this Initiator.
This command-line switch only overrides the specified setting, without implicitly modifying or affecting other options that are not explicitly specified in the command line. | |
| /buildcacheremoteserver=[ip address:port] | Use a different build cache endpoint from the one defined in the Agent settings. The port must also be specified. For example: /buildcacheremoteserver=192.5.8.1:50222
This command-line switch only overrides the specified setting, without implicitly modifying or affecting other options that are not explicitly specified in the command line. | |
| /command | Enables the Make and Build Tools capability of the BuildConsole and allows execution of command lines of various build tools (e.g., Make and Ant), in a distributed manner, without the need to configure Incredibuild in any way. | The build tools must be installed on the initiating machine. |
| /Disable | Disables the Incredibuild Agent. | |
| /Enable | Enables the Incredibuild Agent. | |
| /Help | Shows usage help and version information. | |
| /KeepOrigJobsNum=[True/False] | Forces Incredibuild to use the original value for the -j switch. | By default, Incredibuild changes the value of the -j switch to 200 if the original value is higher than 200. Setting this option to True, allows for higher values of -j. |
| /Log[=filename] | Writes build output to a file. | If filename is omitted, 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, or Detailed. |
| /MaxCPUS=<n> | Overrides global maximum CPUs/Cores in 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. For example, 8.1, 10, 11, 2016, 2019, 2022, or 2025. |
/MinWinVer="<Version>" | Specifies the minimal operating system required by remote Agents assigned to this build. | Agents with an older OS will not be assigned to the build. For example, 8.1, 10, 11, 2016, 2019, 2022, or 2025. |
| /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 build output. |
/msbuildargs="/myarg1 /myarg2" | Passes additional arguments to MSBuild when using the BuildConsole command /usemsbuild switch. | For example:
BuildConsole dcom.sln /rebuild /cfg="debug|win32" /msbuildargs="/detailedsummary" /usemsbuild |
| /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 build initiated by this Agent is already running a BuildConsole/command, it exits with a Another build already running message. | |
| /OpenMonitor | Opens the Build Monitor window showing the build progress. | |
| /out=filename | Redirects entire command line output to a file. | |
| /QueryLicense | Displays information regarding the active license, allocated packages, and maintenance expiration date. | |
| /Reset | Clears the Agent file cache contents. | |
/SETENV="<name>=<value>" | Sets or overrides environment variables for the context of the run build. | Use /SETENV several times to set/override multiple variables. |
| /ShowAgent | Shows the Agent used to build each file. | |
| /ShowCmd | Shows, for each file built, the command-line used by Incredibuild to build the file. | |
| /ShowTime | Shows the Start and Finish time for each file built. | |
| /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 | Stops a currently running build on the local machine. | BuildConsole /command returns the code 2 when a build has been stopped.
If /stop was used and no build is currently running, code 3 is returned. |
| /StopOnErrors | Stops the build as soon as an error is encountered. | |
| /Title=<build title> | Specifies a custom header line to be displayed in the beginning of the build output text. This title is also used for the Build History and Build Monitor displays. | Value may be surrounded by quotes. |
| /usemsbuild | Forces the usage of MSBuild | By default, Incredibuild uses Devenv to perform the build. Using this switch, Incredibuild will use MSBuild which will enable the option to add specific MSBuild flag using the /msbuildargs as can be seen below.
This will automatically use the 64 bit MSBuild for VS 2022 and later, and the 32 bit MSBuild for earlier VS versions.
To ignore this automatic detection and manually specify which version to use, add =32 or =64 (e.g. /usemsbuild=32) |
| /Wait | If another build initiated by this Agent is currently running, waits until that build is finished and then starts the new build. This is also the default behavior. | |
When passing /buildcacheremoteserver=host:port and /buildcachelocal=ON, both the local and remote caches are used (the local cache takes precedence over the remote cache, meaning that the cache is read from both, but is written only to local, and if anything is missing from local, and is located in remote, then it is retrieved from remote and written to local).
When passing /buildcacheremoteserver=host:port and /buildcachelocal=OFF, only the remote cache is used.
When passing only /buildcacheremoteserver=host:port with no /buildcachelocal value, if the local cache is off in the agent settings or Web UI, then only the remote cache is used. If local cache is on in agent settings or Web UI, then both the local and remote caches are used. | | |
| /BuildCacheProfile=<file_path> | When /BuildCacheProfile=<file_path> is specified, the file is used instead of the override profile (C:\ProgramData\Incredibuild\BuildCache\BuildCache_profile.xml). If the file is not accessible, the build proceeds with the default Build Cache profile. | |
| /ClearBuildCache | Clears all the Build Cache data from the agent it is executed on. | |
| /LimitBMData=0/1/2/3 | Limits the build monitor data produced and displayed. | 0 - display all data without limits
1 - disable all data writing, do not display anything
2 - disable data writing, only display bars
3 - disable data writing, only display graphs |
| /QueryAgentStatus | Queries the status of the agent, and if any of the services are not running, returns a list of services that are running, and a list of services that are not running.
Use this option as part of a build flow to verify that the agent is ready to accelerate a build. | |
| /rootTaskAware | When enabled, inherits the build status from your Build System to Incredibuild, regardless of whether some tasks had errors or not. If there were errors on some tasks but the build was completed successfully, the build status is orange in the Build Monitor. | Disabled by default. Set /rootTaskAware=1 to enable |
| /UseCloudHelpers | When Cloud Helpers are enabled, this setting determines if they are used to assist in the current build. By default, the value is true. To prevent Cloud helpers from assisting in a build, set /UseCloudHelpers=false. | |
