cd77560297
* ci: add caching and fix workflow failures - Add UV package caching to all workflows for faster dependency installation - Add pre-commit hook caching with OS-specific cache keys - Skip no-commit-to-branch hook in CI (fails on main branch) - Remove broken apt cache action (doesn't work with PPAs) - Simplify FreeCAD command detection (PPA installs to standard PATH) - Add FreeCAD Python version logging for debugging * ci: Add code Rabbit configuration file * ci: fix issues in CI workflows * ci: add uv.lock * ci: tweaks * ci: Fix errors and add UUID generation and checking * ci: Use the GitHub FreeCAD release latest stables * ci: skip macro test for now, due to headless mode * feat: Add a multi export macro * ci: Fix tests * ci: fix docker build workflow * ci: skip trufflehog in GitHub Actions due to wasm panic bug TruffleHog has a known wasm/go-re2 panic bug that causes failures in GitHub Actions environment. The hook still runs locally during development for secrets detection. - Add trufflehog to SKIP env var in pre-commit.yaml - Update trufflehog to v3.88.7 (latest) - Add reference to upstream issue #3321 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * test: use boolean holes instead of PartDesign::Hole in CI PartDesign::Hole has a CADKernelError bug in FreeCAD AppImage headless mode on Linux (used in GitHub Actions) where it fails with "Cannot make face from profile". The SmartCutter class already supports boolean holes as an alternative. Changes: - Modify SmartCutter.execute() to use boolean holes by default - Update all test assertions for Part::Feature output type - Update test docstrings and class descriptions - Remove PartDesign-specific checks (Group, Sketcher::SketchObject) - Update workflow comment explaining the CI limitation Boolean holes work reliably in both GUI and headless mode across all FreeCAD configurations. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * ci: clean up GitHub Actions workflows * ci: Dependabot improvements * ci: add CodeQL scanning workflow * ci: AI review suggested improvements * ci: add coderabbit updates for intentional decisions --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
413 lines
15 KiB
Plaintext
413 lines
15 KiB
Plaintext
# FreeCAD plugin and macro commands
|
|
# Usage: just freecad::run-gui, just freecad::install-bridge-macro, etc.
|
|
|
|
# Project root directory (justfile_directory() returns the main justfile's directory)
|
|
project_root := justfile_directory()
|
|
|
|
# =============================================================================
|
|
# Running FreeCAD
|
|
# =============================================================================
|
|
|
|
# Run MCP bridge server in FreeCAD headless mode
|
|
run-headless:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
PROJECT_DIR="{{project_root}}"
|
|
SCRIPT_PATH="${PROJECT_DIR}/src/freecad_mcp/freecad_plugin/headless_server.py"
|
|
|
|
# Find FreeCADCmd executable based on OS
|
|
FREECAD_CMD=""
|
|
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
# macOS: Check common locations
|
|
if [[ -x "/Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd" ]]; then
|
|
FREECAD_CMD="/Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd"
|
|
elif [[ -x "$HOME/Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd" ]]; then
|
|
FREECAD_CMD="$HOME/Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd"
|
|
fi
|
|
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
|
# Linux: Check common locations and PATH
|
|
if command -v freecadcmd &> /dev/null; then
|
|
FREECAD_CMD="freecadcmd"
|
|
elif command -v FreeCADCmd &> /dev/null; then
|
|
FREECAD_CMD="FreeCADCmd"
|
|
elif [[ -x "/usr/bin/freecadcmd" ]]; then
|
|
FREECAD_CMD="/usr/bin/freecadcmd"
|
|
elif [[ -x "/usr/local/bin/freecadcmd" ]]; then
|
|
FREECAD_CMD="/usr/local/bin/freecadcmd"
|
|
elif [[ -x "/opt/freecad/bin/FreeCADCmd" ]]; then
|
|
FREECAD_CMD="/opt/freecad/bin/FreeCADCmd"
|
|
fi
|
|
else
|
|
# Windows: Check common locations
|
|
if [[ -x "$PROGRAMFILES/FreeCAD 1.0/bin/FreeCADCmd.exe" ]]; then
|
|
FREECAD_CMD="$PROGRAMFILES/FreeCAD 1.0/bin/FreeCADCmd.exe"
|
|
elif [[ -x "$PROGRAMFILES/FreeCAD/bin/FreeCADCmd.exe" ]]; then
|
|
FREECAD_CMD="$PROGRAMFILES/FreeCAD/bin/FreeCADCmd.exe"
|
|
fi
|
|
fi
|
|
|
|
if [[ -z "$FREECAD_CMD" ]]; then
|
|
echo "ERROR: FreeCADCmd not found!"
|
|
echo ""
|
|
echo "Please install FreeCAD or set FREECAD_CMD environment variable:"
|
|
echo " export FREECAD_CMD=/path/to/FreeCADCmd"
|
|
echo " just freecad::run-headless"
|
|
echo ""
|
|
echo "Common locations:"
|
|
echo " macOS: /Applications/FreeCAD.app/Contents/Resources/bin/freecadcmd"
|
|
echo " Linux: /usr/bin/freecadcmd or freecadcmd"
|
|
echo " Windows: C:\\Program Files\\FreeCAD 1.0\\bin\\FreeCADCmd.exe"
|
|
exit 1
|
|
fi
|
|
|
|
echo "Using FreeCAD: $FREECAD_CMD"
|
|
echo ""
|
|
|
|
# Add project src to PYTHONPATH so FreeCAD can find the module
|
|
export PYTHONPATH="${PROJECT_DIR}/src:${PYTHONPATH:-}"
|
|
|
|
# Run FreeCADCmd with the headless server script
|
|
"$FREECAD_CMD" "$SCRIPT_PATH"
|
|
|
|
# Run MCP bridge with custom FreeCAD path
|
|
run-headless-custom freecad_cmd:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
PROJECT_DIR="{{project_root}}"
|
|
SCRIPT_PATH="${PROJECT_DIR}/src/freecad_mcp/freecad_plugin/headless_server.py"
|
|
|
|
if [[ ! -x "{{freecad_cmd}}" ]]; then
|
|
echo "ERROR: FreeCADCmd not found or not executable: {{freecad_cmd}}"
|
|
exit 1
|
|
fi
|
|
|
|
echo "Using FreeCAD: {{freecad_cmd}}"
|
|
echo ""
|
|
|
|
# Add project src to PYTHONPATH so FreeCAD can find the module
|
|
export PYTHONPATH="${PROJECT_DIR}/src:${PYTHONPATH:-}"
|
|
|
|
# Run FreeCADCmd with the headless server script
|
|
"{{freecad_cmd}}" "$SCRIPT_PATH"
|
|
|
|
# Run FreeCAD GUI with MCP bridge plugin auto-started
|
|
run-gui:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
PROJECT_DIR="{{project_root}}"
|
|
|
|
# Use the gui_startup.py script from the project
|
|
STARTUP_SCRIPT="${PROJECT_DIR}/src/freecad_mcp/freecad_plugin/gui_startup.py"
|
|
|
|
if [[ ! -f "$STARTUP_SCRIPT" ]]; then
|
|
echo "ERROR: Startup script not found: $STARTUP_SCRIPT"
|
|
exit 1
|
|
fi
|
|
|
|
# Set environment variable for the project path
|
|
export FREECAD_MCP_PROJECT_PATH="${PROJECT_DIR}/src"
|
|
|
|
# Find FreeCAD GUI executable based on OS
|
|
FREECAD_GUI=""
|
|
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
# macOS: Use 'open' command for .app bundles
|
|
if [[ -d "/Applications/FreeCAD.app" ]]; then
|
|
FREECAD_GUI="/Applications/FreeCAD.app"
|
|
elif [[ -d "$HOME/Applications/FreeCAD.app" ]]; then
|
|
FREECAD_GUI="$HOME/Applications/FreeCAD.app"
|
|
fi
|
|
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
|
# Linux: Check common locations and PATH
|
|
if command -v freecad &> /dev/null; then
|
|
FREECAD_GUI="freecad"
|
|
elif command -v FreeCAD &> /dev/null; then
|
|
FREECAD_GUI="FreeCAD"
|
|
elif [[ -x "/usr/bin/freecad" ]]; then
|
|
FREECAD_GUI="/usr/bin/freecad"
|
|
elif [[ -x "/usr/local/bin/freecad" ]]; then
|
|
FREECAD_GUI="/usr/local/bin/freecad"
|
|
elif [[ -x "/opt/freecad/bin/FreeCAD" ]]; then
|
|
FREECAD_GUI="/opt/freecad/bin/FreeCAD"
|
|
fi
|
|
else
|
|
# Windows: Check common locations
|
|
if [[ -x "$PROGRAMFILES/FreeCAD 1.0/bin/FreeCAD.exe" ]]; then
|
|
FREECAD_GUI="$PROGRAMFILES/FreeCAD 1.0/bin/FreeCAD.exe"
|
|
elif [[ -x "$PROGRAMFILES/FreeCAD/bin/FreeCAD.exe" ]]; then
|
|
FREECAD_GUI="$PROGRAMFILES/FreeCAD/bin/FreeCAD.exe"
|
|
fi
|
|
fi
|
|
|
|
if [[ -z "$FREECAD_GUI" ]]; then
|
|
rm -f "$STARTUP_SCRIPT"
|
|
echo "ERROR: FreeCAD not found!"
|
|
echo ""
|
|
echo "Please install FreeCAD or use:"
|
|
echo " just freecad::run-gui-custom /path/to/FreeCAD"
|
|
echo ""
|
|
echo "Common locations:"
|
|
echo " macOS: /Applications/FreeCAD.app"
|
|
echo " Linux: /usr/bin/freecad or freecad"
|
|
echo " Windows: C:\\Program Files\\FreeCAD 1.0\\bin\\FreeCAD.exe"
|
|
exit 1
|
|
fi
|
|
|
|
echo "Starting FreeCAD with MCP bridge..."
|
|
echo "Using FreeCAD: $FREECAD_GUI"
|
|
echo ""
|
|
|
|
# Add project src to PYTHONPATH so FreeCAD can find the module
|
|
export PYTHONPATH="${PROJECT_DIR}/src:${PYTHONPATH:-}"
|
|
|
|
# Launch FreeCAD with the startup script
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
# macOS: Use 'open' with --args to pass the script
|
|
open -a "$FREECAD_GUI" --args "$STARTUP_SCRIPT"
|
|
else
|
|
# Linux/Windows: Run directly with script as argument
|
|
"$FREECAD_GUI" "$STARTUP_SCRIPT" &
|
|
fi
|
|
|
|
echo "FreeCAD is starting..."
|
|
echo "The MCP bridge will start automatically once FreeCAD initializes."
|
|
echo ""
|
|
echo "Note: You can now start/restart your MCP client (Claude Code, etc.) to connect."
|
|
|
|
# Run FreeCAD GUI with custom path
|
|
run-gui-custom freecad_path:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
PROJECT_DIR="{{project_root}}"
|
|
|
|
# Create a temporary startup script
|
|
STARTUP_SCRIPT=$(mktemp /tmp/freecad_mcp_startup.XXXXXX.py)
|
|
|
|
cat > "$STARTUP_SCRIPT" << EOF
|
|
# FreeCAD MCP Bridge Auto-Start Script
|
|
import sys
|
|
project_path = "${PROJECT_DIR}/src"
|
|
if project_path not in sys.path:
|
|
sys.path.insert(0, project_path)
|
|
|
|
try:
|
|
from freecad_mcp.freecad_plugin.server import FreecadMCPPlugin
|
|
plugin = FreecadMCPPlugin(
|
|
host="localhost",
|
|
port=9876,
|
|
xmlrpc_port=9875,
|
|
enable_xmlrpc=True,
|
|
)
|
|
plugin.start()
|
|
FreeCAD.Console.PrintMessage("\\nMCP Bridge started!\\n")
|
|
FreeCAD.Console.PrintMessage(" - XML-RPC: localhost:9875\\n")
|
|
FreeCAD.Console.PrintMessage(" - Socket: localhost:9876\\n\\n")
|
|
except Exception as e:
|
|
FreeCAD.Console.PrintError(f"Failed to start MCP Bridge: {e}\\n")
|
|
EOF
|
|
|
|
echo "Starting FreeCAD with MCP bridge..."
|
|
echo "Using FreeCAD: {{freecad_path}}"
|
|
echo ""
|
|
|
|
export PYTHONPATH="${PROJECT_DIR}/src:${PYTHONPATH:-}"
|
|
|
|
if [[ "$OSTYPE" == "darwin"* ]] && [[ "{{freecad_path}}" == *.app ]]; then
|
|
open -a "{{freecad_path}}" --args "$STARTUP_SCRIPT"
|
|
else
|
|
"{{freecad_path}}" "$STARTUP_SCRIPT" &
|
|
fi
|
|
|
|
echo "FreeCAD is starting with MCP bridge..."
|
|
|
|
# =============================================================================
|
|
# Macro Installation
|
|
# =============================================================================
|
|
|
|
# Install the StartMCPBridge macro to FreeCAD's macro directory
|
|
install-bridge-macro:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
PROJECT_DIR="{{project_root}}"
|
|
|
|
# Determine macro directory based on OS
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
MACRO_DIR="$HOME/Library/Application Support/FreeCAD/Macro"
|
|
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
|
MACRO_DIR="$HOME/.local/share/FreeCAD/Macro"
|
|
else
|
|
MACRO_DIR="$APPDATA/FreeCAD/Macro"
|
|
fi
|
|
|
|
mkdir -p "$MACRO_DIR"
|
|
|
|
# Copy the macro file and replace the placeholder with the actual project path
|
|
sed "s|__PROJECT_PATH__|${PROJECT_DIR}/src|g" \
|
|
"${PROJECT_DIR}/macros/Start_MCP_Bridge/StartMCPBridge.FCMacro" \
|
|
> "$MACRO_DIR/StartMCPBridge.FCMacro"
|
|
|
|
echo "StartMCPBridge macro installed to: $MACRO_DIR"
|
|
echo ""
|
|
echo "To use:"
|
|
echo " 1. Start FreeCAD"
|
|
echo " 2. Go to: Macro -> Macros -> StartMCPBridge -> Execute"
|
|
echo " 3. Restart your MCP client (Claude Code, etc.) to connect"
|
|
|
|
# Uninstall the StartMCPBridge macro
|
|
uninstall-bridge-macro:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
MACRO_DIR="$HOME/Library/Application Support/FreeCAD/Macro"
|
|
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
|
MACRO_DIR="$HOME/.local/share/FreeCAD/Macro"
|
|
else
|
|
MACRO_DIR="$APPDATA/FreeCAD/Macro"
|
|
fi
|
|
rm -f "$MACRO_DIR/StartMCPBridge.FCMacro"
|
|
echo "StartMCPBridge macro uninstalled"
|
|
|
|
# Install the CutObjectForMagnets macro to FreeCAD's macro directory
|
|
install-cut-macro:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
PROJECT_DIR="{{project_root}}"
|
|
|
|
# Determine macro directory based on OS
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
MACRO_DIR="$HOME/Library/Application Support/FreeCAD/Macro"
|
|
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
|
MACRO_DIR="$HOME/.local/share/FreeCAD/Macro"
|
|
else
|
|
MACRO_DIR="$APPDATA/FreeCAD/Macro"
|
|
fi
|
|
|
|
mkdir -p "$MACRO_DIR"
|
|
|
|
# Copy the macro file
|
|
cp "${PROJECT_DIR}/macros/Cut_Object_for_Magnets/CutObjectForMagnets.FCMacro" "$MACRO_DIR/"
|
|
|
|
# Optionally copy the icon if it exists
|
|
if [[ -f "${PROJECT_DIR}/macros/Cut_Object_for_Magnets/CutObjectForMagnets.svg" ]]; then
|
|
cp "${PROJECT_DIR}/macros/Cut_Object_for_Magnets/CutObjectForMagnets.svg" "$MACRO_DIR/"
|
|
fi
|
|
|
|
echo "CutObjectForMagnets macro installed to: $MACRO_DIR"
|
|
echo ""
|
|
echo "To use:"
|
|
echo " 1. Start FreeCAD"
|
|
echo " 2. Select an object to cut"
|
|
echo " 3. Go to: Macro → Macros → CutObjectForMagnets → Execute"
|
|
echo ""
|
|
echo "For angled cuts:"
|
|
echo " 1. Create a datum plane at your desired angle (Part Design → Create datum plane)"
|
|
echo " 2. Select 'Model Plane' in the macro dialog"
|
|
echo " 3. Choose your datum plane from the dropdown"
|
|
|
|
# Uninstall the CutObjectForMagnets macro
|
|
uninstall-cut-macro:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
MACRO_DIR="$HOME/Library/Application Support/FreeCAD/Macro"
|
|
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
|
MACRO_DIR="$HOME/.local/share/FreeCAD/Macro"
|
|
else
|
|
MACRO_DIR="$APPDATA/FreeCAD/Macro"
|
|
fi
|
|
rm -f "$MACRO_DIR/CutObjectForMagnets.FCMacro"
|
|
rm -f "$MACRO_DIR/CutObjectForMagnets.svg"
|
|
echo "CutObjectForMagnets macro uninstalled"
|
|
|
|
# Install the MultiExport macro to FreeCAD's macro directory
|
|
install-export-macro:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
PROJECT_DIR="{{project_root}}"
|
|
|
|
# Determine macro directory based on OS
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
MACRO_DIR="$HOME/Library/Application Support/FreeCAD/Macro"
|
|
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
|
MACRO_DIR="$HOME/.local/share/FreeCAD/Macro"
|
|
else
|
|
MACRO_DIR="$APPDATA/FreeCAD/Macro"
|
|
fi
|
|
|
|
mkdir -p "$MACRO_DIR"
|
|
|
|
# Copy the macro file
|
|
cp "${PROJECT_DIR}/macros/Multi_Export/MultiExport.FCMacro" "$MACRO_DIR/"
|
|
|
|
# Optionally copy the icon if it exists
|
|
if [[ -f "${PROJECT_DIR}/macros/Multi_Export/MultiExport.svg" ]]; then
|
|
cp "${PROJECT_DIR}/macros/Multi_Export/MultiExport.svg" "$MACRO_DIR/"
|
|
fi
|
|
|
|
echo "MultiExport macro installed to: $MACRO_DIR"
|
|
echo ""
|
|
echo "To use:"
|
|
echo " 1. Start FreeCAD"
|
|
echo " 2. Select one or more objects to export"
|
|
echo " 3. Go to: Macro → Macros → MultiExport → Execute"
|
|
echo " 4. Choose export formats (STL, STEP, 3MF selected by default)"
|
|
echo " 5. Set output directory and filename"
|
|
echo " 6. Click Export"
|
|
|
|
# Uninstall the MultiExport macro
|
|
uninstall-export-macro:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
MACRO_DIR="$HOME/Library/Application Support/FreeCAD/Macro"
|
|
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
|
MACRO_DIR="$HOME/.local/share/FreeCAD/Macro"
|
|
else
|
|
MACRO_DIR="$APPDATA/FreeCAD/Macro"
|
|
fi
|
|
rm -f "$MACRO_DIR/MultiExport.FCMacro"
|
|
rm -f "$MACRO_DIR/MultiExport.svg"
|
|
echo "MultiExport macro uninstalled"
|
|
|
|
# Install all macros to FreeCAD's macro directory
|
|
install-all-macros: install-bridge-macro install-cut-macro install-export-macro
|
|
@echo "All macros installed successfully!"
|
|
|
|
# Uninstall all macros from FreeCAD's macro directory
|
|
uninstall-all-macros: uninstall-bridge-macro uninstall-cut-macro uninstall-export-macro
|
|
@echo "All macros uninstalled successfully!"
|
|
|
|
# =============================================================================
|
|
# Plugin Installation
|
|
# =============================================================================
|
|
|
|
# Install the FreeCAD plugin to user's FreeCAD directory
|
|
install-plugin:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
PLUGIN_DIR="$HOME/Library/Application Support/FreeCAD/Mod/MCPBridge"
|
|
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
|
PLUGIN_DIR="$HOME/.local/share/FreeCAD/Mod/MCPBridge"
|
|
else
|
|
PLUGIN_DIR="$APPDATA/FreeCAD/Mod/MCPBridge"
|
|
fi
|
|
mkdir -p "$PLUGIN_DIR"
|
|
cp -r src/freecad_mcp/freecad_plugin/* "$PLUGIN_DIR/"
|
|
echo "Plugin installed to: $PLUGIN_DIR"
|
|
|
|
# Uninstall the FreeCAD plugin
|
|
uninstall-plugin:
|
|
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
if [[ "$OSTYPE" == "darwin"* ]]; then
|
|
PLUGIN_DIR="$HOME/Library/Application Support/FreeCAD/Mod/MCPBridge"
|
|
elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
|
PLUGIN_DIR="$HOME/.local/share/FreeCAD/Mod/MCPBridge"
|
|
else
|
|
PLUGIN_DIR="$APPDATA/FreeCAD/Mod/MCPBridge"
|
|
fi
|
|
rm -rf "$PLUGIN_DIR"
|
|
echo "Plugin uninstalled"
|