Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The command line syntax for FBCMD is as follows:

FBCMD.

...

EXE <ProjectFile> [options

...

]

...

Options

Switch

Behaviour

Example

/P<ProjectFile> 

FinalBuilder Project File to execute

 

The /P is optional, you can just specify the project file name by itself instead (although in that case it must be after any other options.)

The FinalBuilder project file

/P"C:\Build\MyProject.fbz7"

or

-redirectoutput:<redirectoutput>

-r:<redirectoutput>

Output messages to text file instead of console.

-r:"C:\BuildTemp\MyProjectRedirectLog.fbz7"

/I

Ignore all system message (eg. Ctrl-C, Shutdown.)

/I

/A

Allow interactive actions (message dialogs, prompt for variables, etc.)

/A

/V

Set FinalBuilder variables, in the form VarName=VarValue. The variables must be already defined Project or User variables.

 

Separate multiple name/value pairs with semicolons. If the variable value contains spaces, enclose it in quotes.

/VMAJORVER=3;MINORVER=1

/C

Validate project before execution.

/C

/S

Disable logging. No log file will be generated, and an existing log file will not be updated. The Export Log action will not function.

 

This option may give a significant performance speedup if the build runs many actions very quickly. Console output is still enabled (see below.)

 

With this option (or /TL) enabled, the same project can be opened multiple times concurrently.

/S

/H

Disable hierarchical logging.

/H

/TL

Logging is still performed, but to a temporary log file. This means actions such as the Export Log action still function.

 

With this option (or /S) enabled, the same project can be opened multiple times concurrently.

/TL

@

Read arguments from a parameter text file.

 

Each line of the file should specify a different command line parameter.

@"MyParameters.txt"

/O

Close any other instances of the %ProductName% IDE which are idle with unmodified copies of the same project file.

 

/OF

Forcibly close any other instances of the %ProductName% IDE which are open with a copy of the same project file. The IDE will first attempt to close cleanly, otherwise will terminate a running project or force terminate a stuck project. Unsaved changes to projects will be lost. Mutually exclusive with /o.

 

† = Warning: Forcibly closing other projects may cause loss of data and should be used sparingly.

Options for console output (this affects the data written to the console, not to the project's log file:

Switch

Behaviour

Example

/L

Output console messages to a specified text file instead of the console.

/L"C:\Temp\MyProjectOutput.txt"

/LA

Like /L, but append to the text file instead of overwriting.

/L"C:\Temp\ExistingOutput.txt"

/LN

Like /L, but fail if the file already exists (instead of overwriting.)

/L"C:\Temp\MoreOutput.txt"

/B

Suppress FinalBuilder banner.

/B

/XL

Don't output Action List start and end messages to the console.

/XL

/XA

Don't output action start messages to the console.

/XA

/XM

Don't send action output to the console.

/XAM

* = Or the specified text file, if using /L, /LA or /LN.

...

log"

-redirectmode:<redirectmode>

-rm:<redirectmode> 

Redirect Mode, O : overwrite, N : do not overwrite, A : Append

-rm:O

-params

-@

Parameter file. Specify a file which contains all command line options to use.

-@:"C:\Temp\Params.txt"

-logexceptions

-le

 Write all exceptions to the log.

-le

-allowinteractive

-ai

Allow interactive actions.

-ai

-quiet

-q

Quiet mode. Only log build start, end and errors.

-q

-silent

-s

Silent mode. Nothing is written out to the log.

-s

-nobanner

-nb

Suppress product banner in output.

-nb

-exportlog:<exportlog>

-ex:<exportlog>

Export Log to a file at the end of the build (file extension determines format)

-ex:"C:\Temp\Build.html"

-heirachlog

-h

Disable hierarchical logging.

-h

-validate

-vp

Validate project before execution.-vp

-noctrl

-ic

Ignore all system message (eg. Ctrl-C, Shutdown)-ic

-closeother

-co

Close project if open in the IDE (see FBCMD help topic.-co

-closeforce

-cf

Forcibly close project if open in the IDE (use with caution).-cf

-templog

-tl

Log to a temporary log file.-tl

-targets:<targets>

-t:<targets>

List of targets to run from the project. More than one target can be included by seperating with a semi-colon.

-t:Build

-packages:<packages>

-pk:<packages>

Packages to load for running the FinalBuidler project. Each entry should be seperated by a semi-colon. Overrides the packages set to load in the FinalBuilder options.

-pk:JustThePackageRequired.fbap

-variables:<variables>

-v:<variables>

Set FinalBuilder variables, in the form VarName=VarValue. The variables must be already defined Project or User variables. Separate multiple name/value pairs with semicolons. If the variable value contains spaces, enclose it in quotes.

-v:MyVar="Some Text"

-logexclusions:<logexclusions>

-x:<logexclusions>

Don't output selected message types to the console. T : Target start/stop messages, A : Action start messages, M : Action output messages.

-x:T

See Also

Scheduling builds | IDE Command Line Interface

...