To run Alibre Script code from an Alibre Design addon, only the ScriptRunner class is required. This repository (the alibre-script-adk) and its related content were created to provide community and public resources, but they are not required.

ADK Overview:

1. ScriptRunner Class - CODE
2. Integration Class
3. Add-on Helper Classs
4. Tools - Helper scripts and executables addon generation, no code tools
5. Example code
6. Demo addons
7. API Testing report addon
8. Reports

Tested/Confirmed APIs:

• ASDictionary | builtin.type
• ASDictionaryEntry | builtin.type
• AssembledPart | builtin.type
• AssembledSubAssembly | builtin.type
• Assembly | builtin.type
• Axis | builtin.type
• Bspline | builtin.type
• Bspline3D | builtin.type
• Circle | builtin.type
• CircularArc | builtin.type
• CircularArc3D | builtin.type
• Configuration | builtin.type
• CurrentAssemblies | builtin.Func[list]
• CurrentAssembly | builtin.Func[Assembly]
• CurrentPart | builtin.Func[Part]
• CurrentParts | builtin.Func[list]
• Edge | builtin.type
• Ellipse | builtin.type
• EllipticalArc | builtin.type
• Face | builtin.type
• Feature | builtin.type
• GearSketch | builtin.type
• Global | builtin.type
• GlobalParameters | builtin.type
• GuideCurveTypes | builtin.type
• IAssembled | builtin.type
• IAxis | builtin.type
• IChamferable | builtin.type
• IConstrainable | builtin.type
• IFilletable | builtin.type
• IInstance | builtin.type
• IPlane | builtin.type
• IPoint | builtin.type
• ISelectableGeometry | builtin.type
• ISketchFigure | builtin.type
• ISketchFigure3D | builtin.type
• ISketchSurface | builtin.type
• ISweepPath | builtin.type
• Line | builtin.type
• Line3D | builtin.type
• LockTypes | builtin.type
• Material | builtin.type
• Parameter | builtin.type
• ParameterTypes | builtin.type
• ParameterUnits | builtin.type
• Part | builtin.type
• Plane | builtin.type
• Point | builtin.type
• Polyline | builtin.type
• Polyline3D | builtin.type
• PolylinePoint | builtin.type
• PolylinePoint3D | builtin.type
• STL | builtin.type
• Selection | builtin.type
• SessionIdentifier | builtin.str
• Sketch | builtin.type
• Sketch3D | builtin.type
• SketchPoint | builtin.type
• SketchPoint3D | builtin.type
• ThreeD | builtin.type
• ThumbnailOptions | builtin.type
• TwoD | builtin.type
• UnitTypes | builtin.type
• Units | builtin.type
• Utility | builtin.type
• Vertex | builtin.type
• Windows | builtin.Func[Windows]
• WindowsInputTypes | builtin.type

Example/Sample Verified IsWorking List:

• Assembly-Constraints.py

• Bolt-Creator.py

• Calculating-Length-of-Curves.py

• Cap-Screw-ISO-4762-Bolts.py

• Copy-sketch.py

• Create-Reference-Planes-Axes-and-Points.py

• Create-and-Modify-Global-Parameters.py

• Creating-a-3D-Sketch-with-a-Spline-and-an-Arc.py

• Creating-a-Cylinder-Between-Two-Points.py

• Creating-and-Manipulating-Assemblies.py

• Custom-Values-and-Settings-Window.py

• Default-Reference-Geometry.py

• Drop-Down-Lists.py

• Everyone-Loves-a-Slinky.py

• Gear-Example.py

• Geodesic-Dome-Reference-Geometry.py

• Getting-User-Input.py

• Helical-spring.py

• Import-points-from-a-CSV-file-rotate-them-and-connect-into-a-polyline.py

• Importing-Files.py

• Joint-Creator.py

• List-All-Parts-in-an-Assembly-and-Sub-Assemblies.py

• Lofting-with-a-Guide-Curve.py

• Midplane-Extrusion.py

• Mobius-Strip.py

• Modify-an-Existing-Part.py

• Parameters-with-Units.py

• Pocket-Hole-Creator.py

• Polygon-Incircle.py

• Profile-and-Sweep-Path.py

• Reading-from-a-Spreadsheet.py

• Rectangular-hollow-formed-profiles.py

• Reference-Geometry.py

• Scaling-a-Sketch.py

• Servo-Cam.py

• Slice-a-Part.py

• Square-hollow-formed-profiles.py

• Supressing-Unsupressing-and-Removing-Features.py

• Tool-Cutting.py

• Triangle.py

• Type-11-flanges-according-to-BS-EN-1092-PN16.py

• Units.py

• Useful-Dialogs.py

• Wave-washer.py

• Working-with-Configurations.py

• Import and Export

  • MaxCellSize.jpg
  • NormalDeviation.jpg
  • Part Exporter.py
  • STL Exporter.py
  • SurfaceDeviation.jpg

• Mathematical

  • Equation Sketcher.py
  • EquationSketcher.png

• Mechanical

  • Gear Generator.py
  • GearGenerator.png

• Utilities

  • File Copier.py
  • Image to Python.py
  • Pattern Along.py
  • PatternAlong.png
  • Sketch Copier.py
  • SketchCopier.png

• Woodworking

  • Joint Creator.py
  • JointCreatorIcon.png
  • Pocket Hole Creator.py
  • PocketHoleCreatorIcon.png

Demos:

• alibre-nodes-addon
• alibre-shapes-addon
• alibre-nocode-addon
• alibre-vscodium-addon
• alibre-script-runner-addon
• alibre-feature-naming-addon

Tools:

Reports:

Contributions:

SelectionListBox class and Filters class by NateLiquidGravity and sourced 7/23/2025.