BuildForge bfexport: How to Export Projects and Snapshots to XML

The bfexport command is BuildForge’s CLI utility for exporting project data to XML. It is useful when you need a backup before changes, want to move project definitions, or need a portable project snapshot for later import.

Originally published on 2013-04-24; fully revised and updated.

This revision is based on the original post on DevOpsSchool and keeps its command intent while improving structure and readability.

Where bfexport runs and what it exports

The original guide places bfexport in the BuildForge Home Dir – Platform location. The command exports project-related data in XML format.

• Use -l to list available projects and their UUIDs.
• Use -f to write export output to a file.
• The generated file is intended for later import workflows.

Command syntax

To display syntax help, run bfexport with no options.

./bfexport
Usage: bfexport -l
or:
bfexport [-c comment] [-f filename] [-g] [-s] [-L] [-n] <Project name or UUID> <Version name>Code language: HTML, XML (xml)

The original option list also includes -C for server collectors, with a note that it requires -s.

Option reference

Command patterns compared

Typical export workflow

flowchart TD
    A[Open BuildForge platform directory] --> B[Run bfexport -l]
    B --> C[Select project name or UUID]
    C --> D[Decide snapshot scope]
    D --> E[Run bfexport with -f output file]
    E --> F{Need extra config}
    F -- yes --> G[Add -s and optionally -C]
    F -- yes --> H[Add -L or -n if needed]
    F -- no --> I[Save minimal export]
    G --> J[Store XML for import]
    H --> J
    I --> J

Practical command examples

List project names and UUIDs

bfexport -l

Export default project snapshot by project name

bfexport -f helloworld test_project

Export one named snapshot

bfexport -f helloworld test_project snapshot_1

Export by UUID with a comment

bfexport -c "Saving a copy of project before making changes" -f helloworld 675B57CC-8366-11DD-B2E0-043C04E44E1ACode language: JavaScript (javascript)

Include servers and server collectors

./bfexport -c "Saving a copy of project before making changes" -C -s -f Citius-Coverity-Full-parent 6d66e5050c5a1000bcd5cd010bc00bc0Code language: PHP (php)

Parent snapshot syntax shown in the original post

bfexport -f helloworld test_project parent DocumentCode language: PHP (php)

Common pitfalls and best practices

• Always use -f when you need a reusable XML export file.
• Run -l first to avoid typos in project names and to confirm UUIDs.
• If you use -C, include -s as required by the original option notes.
• Add a meaningful -c comment before major project changes.
• Validate parent snapshot syntax in your environment, because the original example is terse and version-specific behavior may differ.

Rajesh Kumar

I’m Rajesh Kumar, a DevOps, SRE, DevSecOps, Cloud, and Platform Engineering expert passionate about sharing practical knowledge, real-world experiences, and industry best practices. I have worked at Cotocus and regularly write about technology, travel, investing, health, product reviews, and digital marketing through my various platforms.

I publish technical articles at DevOps School, travel stories at Holiday Landmark, stock market insights at Stocks Mantra, health and fitness guidance at My Medic Plus, product reviews at TrueReviewNow, and SEO and digital marketing strategies at Wizbrand.