How to Record a Macro in FreeCAD

Recording macros in FreeCAD allows you to automate repetitive 3D modeling tasks by capturing your graphical interface actions and translating them into executable Python code. This guide explains how to start macro recording, perform the intended operations, save the script, and run it later to reproduce your workflow instantly.

Step 1: Open FreeCAD and Prepare Your Workspace

  1. Launch FreeCAD and open an existing project or create a new document.
  2. Select the workbench you intend to work within (such as Part Design, Part, or Draft).
  3. Plan the actions you want to automate, as the recorder will capture every click, shape creation, and property modification while active.

Step 2: Start Macro Recording

  1. Navigate to the top menu and click on Macro.
  2. Select Macro recording... from the dropdown menu (or click the red circle icon on the Macro toolbar).
  3. In the dialog box that appears:
    • Enter a name for your macro in the Macro name field.
    • Choose a storage directory (the default FreeCAD macro folder is recommended).
  4. Click Record to begin tracking your actions. The recording icon in the status bar will indicate that recording is active.

Step 3: Perform the Tasks to Automate

Perform the sequence of actions you want to record directly in the 3D view or property editor. For example:

  • Creating a primitive shape (box, cylinder, etc.).
  • Applying fillets or chamfers.
  • Modifying dimensions or placement properties.

Tip: Avoid unnecessary clicks, panning, or camera rotations, as these can clutter the generated script.

Step 4: Stop Recording

  1. Once your operations are complete, go back to the top menu.
  2. Click Macro and select Stop macro recording (or click the green stop square icon on the Macro toolbar).
  3. FreeCAD automatically generates and saves the Python script corresponding to your actions.

Step 5: Run Your Recorded Macro

  1. Open a new or existing document where you want to execute the sequence.
  2. Click Macro in the top menu and select Macros....
  3. In the list of available macros, select the file you created.
  4. Click the Execute button. FreeCAD will immediately rerun all the recorded commands.

Editing and Customizing Your Macro

To inspect or refine the generated code:

  1. Open the Macros... dialog window.
  2. Highlight your macro and click Edit.
  3. The script will open in the FreeCAD code editor, where you can modify parameter values, add loops, or insert conditional logic to make your automation more dynamic.