Command

Introduction
A FreeCAD command is what is being executed when you press a toolbar button or type a keyboard shortcut. It can be a very simple action, like changing the zoom level of the 3D view or rotating the point of view, or a complex system that will open dialog boxes and wait for the user to perform specific tasks.

Each FreeCAD command has a unique name, that appears in the Category:Command_Reference page. Commands can be launched by a toolbar button, a menu item, or from a python script or the Python console, by running:

FreeCADGui.runCommand("my_Command_Name")

Background
FreeCAD commands are defined per workbench. Workbenches will normally add their command definitions at FreeCAD init time, so the command exists and is available as soon as FreeCAD is started, no matter if the corresponding workbench has been activated yet or not. In some cases however, the workbench author might have decided to not overload/burden the FreeCAD startup process and therefore loaded the command definitions only at workbench init. In those cases, the command will only be available after the workbench has been activated (you have switched to it at least once with the workbench selector).

As most of them require user interaction, FreeCAD commands are only available in GUI-mode, and not in console mode. However, for convenience, most FreeCAD commands will either have a corresponding python function (like or ), or will execute code that is very easy to replicate in a python script and/or macro.

Commands can be defined either in C++ or in Python.

Commands defined in C++
Example of a C++ command definition, usually defined following the structure.

Commands defined in Python
Example of a Python command definition, it can be placed in a directory like.