Commands and Arguments When Using Command Line
To build output from the command line, you need to write commands containing various arguments. The commands always start with the word “madbuild,” followed by the necessary arguments and values.
Here are the available arguments associated with madbuild.
Note Some elements in Flare Desktop reference the old "Central" name, even though it has since been renamed to Flare Online.
Argument |
Description |
---|---|
-batch |
Enter this before the name of the batch target you want to build. |
-centralPassword |
Enter this before your MadCap Flare Online password if you are publishing a target directly to Flare Online. Note Some elements in Flare Desktop reference the old "Central" name, even though it has since been renamed to Flare Online. |
-centralUsername |
Enter this before your MadCap Flare Online user name if you are publishing a target directly to Flare Online. Note Some elements in Flare Desktop reference the old "Central" name, even though it has since been renamed to Flare Online. |
-credentials |
Enter this before credentials that are added directly in the madbuild command. Note If you do not provide credentials, those from your registry (i.e., those you entered in the Destination Editor) will automatically be used. The -credentials and -credentials-file arguments give you a way to use a different set of credentials than those in your registry. |
-credentials-file |
Enter this before the path to a credentials (JSON) file, which contains the actual credentials. |
-export |
Enter this before the path and name of the Flare project file (.flprj) you want to export. See Exporting Projects Using the Command Line. |
-project |
Enter this before the path and name of the Flare project file (.flprj) containing the target(s) you want to build. |
-settings |
Enter this before the export project file name (.flexp) when exporting a project. See Exporting Projects Using the Command Line. |
-target |
Enter this before the name of the Flare target you want to build. |
Note When using madbuild, you can put arguments in a JSON file and reference it (e.g., myConfig.json). This is useful for console apps that have issues with long arguments