BuildForge Help

Exporting Projects from the Command Line

Use the bfexport command to export projects to a named XML file or to standard out (stdout). The export XML file can be used to import projects using the bfimport command or the Management Console (Administration > > Import).

You can use bfexport with the -l option to list the names and index numbers of projects in the Management Console database.

Syntax

The bfexport command is located in <bf-install>/bfexport.exe on Windows and in <bf-install>/Platform/bfexport.pl on UNIX/Linux.

bfexport [-l]
bfexport [-c comment][-f filename] [-g group user] [-s servers][-L LDAP][-n notification][-help] 
<project_name> | <project_index>

Usage

On execution, bfexport must be able to find the buildforge.conf file and access the Management Console database:
  • Execute bfexport from the directory where buildforge.conf is located (<bf-install> on Windows or <bf-install>/Platform on UNIX/Linux)
  • Execute bfexport from any directory by setting the BF_CONFIG_FILE environment variable for the session to the full directory path of buildforge.conf.

Examples

Use the -f filename option to write output to a file. In the example, the index number (1) is used instead of the project name.

bfexport -c "Saving a copy of project before making changes" -f helloworld 1
Note: Do not use the redirect output symbol (>) to redirect output to a file; the resultant file includes logging messages and cannot be used as input file for bfimport or the Management Console import.

Option Descriptions

Option Description
<project_name> The name of the project. The project name or the project index number is required. List the project name last, after command options.
<project_index> The index number of the project. The project index number or project name is required. List the project index last, after command options.
-f filename An optional path and/or file name for bfexport output. If a file name is not provided, bfexport output is saved to stdout. If a path name is not provided, the current working directory is used.
-l list Lists the projects in the Management Console database by name and index number. This option does not require a project name, is not used with other options, and must immediately follow the bfexport command name, otherwise it is ignored.
- c comment Adds a comment to the xml output. The comment must be quoted ("my project version 50"). The comment is added to the <buildforge> XML element.
-g group user Lists the users who are members of the access groups designated to receive notifications. Users and their properties are listed in the <user> XML element.
-s servers Saves to the XML file the servers defined in the Management Console. Servers and their properties are listed in the <server> XML element, along with any associated <auth> and <collector> information.
-L LDAP configuration Lists the LDAP domain controllers for the Management Console. LDAP domain controllers and their properties are listed in the <ldap> XML element.
-n notifications Lists the user-created notification templates assigned to the project. The notification templates and their properties are listed in the <mail-template> XML element.
-C collectors Saves to the XML file the collectors assigned to the servers in the Management Console. Collectors and their properties are listed in the <collector> XML element.