Jump to content

FreeCAD Docker CLI mode

From FreeCAD Documentation

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Overview[edit | edit source]

Docker image of FreeCAD compiled without GUI. This Docker image is especially for developers who only want to use FreeCAD in the command-line interface (CLI).

Benefits[edit | edit source]

All of FreeCAD's dependencies are already installed, compatible with each other, and configured appropriately, allowing you to get started developing very quickly.

  • Easy to use and lightweight.
  • It gives better performance in terms of speed.
  • No need to add FreeCAD paths to import it into Python.

Docker Repository[edit | edit source]

Prerequisites[edit | edit source]

  • 3 GB of free storage
  • Docker

Installation[edit | edit source]

  1. Pull the Docker image.
    docker pull amrit3701/freecad-cli:latest
    
  2. When you successfully pulled Docker image, now you can run image.
    docker run -it amrit3701/freecad-cli:lastest bash
    


Additional information[edit | edit source]

Extend Docker image[edit | edit source]

You can also extend this Docker images to add additional dependencies for your project. For eg

# Dockerfile

FROM amrit3701/freecad-cli:lastest

# Add additional dependencies

# pip3.8 install <some_package>

Import FreeCAD in Python[edit | edit source]

After running Docker image, just run Python.

$ docker run -it amrit3701/freecad-cli:lastest bash
root@f0ec904cf9b9:/# python3.8
Python 3.8.5 (default, Jul 20 2020, 19:48:14)
[GCC 7.5.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import FreeCAD
>>> import Part
>>> import Draft
>>> import Arch

Launch FreeCADCmd[edit | edit source]

To launch FreeCAD inside Docker image, just run FreeCADCmd command.

Discussion[edit | edit source]

FreeCAD forum thread: https://forum.freecad.org/viewtopic.php?f=8&t=45877