xgConsole Command Line Interface

Overview

"xgConsole.exe", located in the IncrediBuild installation folder, is a console application which allows running distributed jobs using the XGE Interfaces extension package from scripts and applications.

To run a distributed Visual Studio build from a script, application or command line, use the BuildConsole.exe command line interface.

Usage

The following syntax is used to operate xgConsole.exe:

xgConsole.exe /COMMAND="<job command line>" [options]

Or:

xgConsole.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:
- 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)

Note that if you get a "'xgConsole' is not recognized as an internal or external command, operable program or batch file." error when running xgConsole, either manually add the IncrediBuild installation folder to your system path or rerun the IncrediBuild setup application on your machine with the "Add IncrediBuild folder to the system path" option selected.

Interface-Specific Usage and Examples

For examples and specific information regarding using xgConsole.exe to activate the different XGE Interfaces, see the following sections:

Command Line Options

The list below covers the xgConsole.exe command line options.
Note: Command line options specific to the Automatic Interception interface are listed in this section.

Option	Function	Notes
@	Specified a response file containing a xgConsole command line.	- Use this option when the command line for running xgConsole is too long to specify explicitly in your script.
/Clean	Cleans all output files (XML Interface only).
/Rebuild	Rebuilds all tasks (XML Interface only).
/SETENV="<name>=<value>"	Sets or overrides environment variables for the context of the run build.	Use /SetEnv several times to set/override multiple variables.
/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.
/Mon[=filename]	Writes a copy of the build progress (.ib_mon) file to the specified location.	- If only a folder name is given, IncrediBuild will generate a GUID for the file name. - A message containing the location of the saved .ib_mon file will be added to the end of the build output.
/out=filename	Redirects entire command line output to a file.
/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.
/Attach	Displays the build output of either the current or the 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, xgConsole will display the entire build output for the last build initiated from this machine.
/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.
/NoWait	When specified, if another build initiated by this Agent is already running xgConsole will exit with a "Another build already running" message.
/NoLogo	Suppresses the "Xoreax IncrediBuild" header in the build output.
/Beep	Plays a sound when build is complete.
/Stop	Stops a currently running build on the local machine.	xgConsole will return the code 3 when a build has been stopped. If /stop was used and no build is currently running, 2 will be returned.
/Enable	Enables the IncrediBuild Agent.
/Disable	Disables the IncrediBuild Agent.
/Reset	Clears the Agent's file cache contents.
/Title=<build title>	Specifies a custom header line which will be displayed in the beginning of the build output text. This title will also be used for the Build History and Build Monitor displays.	Value may be surrounded by quotes.
/ShowCmd	Shows, for each file built, the command-line used by IncrediBuild to build the file (XML Interface only).
/ShowAgent	Shows the Agent used to build each file (XML Interface only).
/ShowTime	Shows the Start and Finish time for each file built (XML Interface only).
/OpenMonitor	Opens the Build Monitor window showing the build progress.
/MaxCPUS=<n>	Override global max. CPUs/Cores in build setting
/Help	Shows usage help and version information.

Return Codes

xgConsole 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.

Additional Notes:

Only one build at a time can be executed on a single machine. Attempting to run more than one build will pause until the currently running build ends, and will then start the new build.

Converted from CHM to HTML with chm2web Standard 2.7 (unicode)