Headless FreeCAD

From FreeCAD Documentation
Jump to navigation Jump to search
Other languages:


This wiki page will document various aspect of running FreeCAD in the console without enabling the GUI (Graphical User Interface) or what is called 'headless'.

Scenegraph Representation

As it's not possible to create or access the view provider in headless mode. What's possible is to load FreeCADGui in headless mode but there is no way to access the GUI document because it won't be created and consequently there exist no view providers.

However, what's possible is to create a scenegraph representation of an object:

import FreeCADGui as Gui
from pivy import coin

doc = App.newDocument()
obj = doc.addObject("Part::Box","Box")
view = Gui.subgraphFromObject(obj)

See: forum thread.


Searching FreeCAD Modules

  1. Open the terminal and type:
    $ /path/to/FreeCAD -c
    $ /path/to/FreeCADCmd
  2. A python shell will start with a prompt. Type help().
  3. A help text is displayed.
  4. Type modules freecad.