FreeCAD Build Tool

Start up and Configuration

Module Creation

Index

Overview

The FreeCAD build tool or fcbt is a python script located at

trunc/src/Tools/fcbt.py

It can be used to simplify some frequent tasks in building, distributing and extending FreeCAD.

Usage

With Python correctly installed, fcbt can be invoked by the command

python fbct.py

It displays a menu, where you can select the task you want to use it for:

FreeCAD Build Tool
 Usage:
    fcbt <command name> [command parameter]
 possible commands are:
  - DistSrc         (DS)   Build a source Distr. of the current source tree
  - DistBin         (DB)   Build a binary Distr. of the current source tree
  - DistSetup       (DI)   Build a Setup Distr. of the current source tree
  - DistSetup       (DUI)  Build a User Setup Distr. of the current source tree
  - DistAll         (DA)   Run all three above modules
  - NextBuildNumber (NBN)  Increase the Build Number of this Version
  - CreateModule    (CM)   Insert a new FreeCAD Module in the module directory
 
 For help on the modules type:
   fcbt <command name> ?

At the input promt enter the abbreviated command you want to call. For example type "CM" for creating a module.

DistSrc

The command "DS" creates a source distribution of the current source tree.

DistBin

The command "DB" creates a binary distribution of the current source tree.

DistSetup

The command "DI" creates a setup distribution of the current source tree.

DistSetup

The command "DUI" creates a user setup distribution of the current source tree.

DistAll

The command "DA" executes "DS", "DB" and "DI" in sequence.

NextBuildNumber

The "NBN" command increments the build number to create a new release version of FreeCAD.

CreateModule

The "CM" command creates a new application module.

Start up and Configuration

Module Creation

Index

User documentation

• Getting started
• Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
• Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

---

• Help: Tutorials, Video tutorials
• Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

---

• Addons: Addon Manager, External workbenches, Scripting and macros

---

• Hubs: User hub, Power users hub, Developer hub