ForgeCAD

https://forgecad.io/docs
Admin
ForgeCAD is a code-first parametric CAD platform that lets developers build 3D models using...
Tokens:109,898
Snippets:1,159
Trust Score:2.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Quick Start Workflow

Source: https://forgecad.io/docs/cli

Standard sequence for installing the CLI, initializing a project, creating a model, and launching the studio.

```bash
# 1. Install
npm install -g forgecad

# 2. Create a dedicated local project folder
mkdir spool-adapter
cd spool-adapter
forgecad project init "Spool Adapter" --visibility private

# 3. Create a first model file
forgecad new adapter --template part

# 4. Open the local editor
forgecad studio .

# 5. Validate, export, sign in, and push to the browser
forgecad run adapter.forge.js
forgecad export stl adapter.forge.js
forgecad login
forgecad project push
forgecad project open
```

--------------------------------

### Install Core Skills Only

Source: https://forgecad.io/docs/ai-usage

Installs only the core modeling skill, excluding companion workflows.

```bash
forgecad skill install --core-only
```

--------------------------------

### Install ForgeCAD Skills

Source: https://forgecad.io/docs/skills

Command to install the core ForgeCAD skill and its companion workflow skills.

```bash
forgecad skill install
```

--------------------------------

### Manage ForgeCAD Skills

Source: https://forgecad.io/docs/cli

Install skill libraries or export project context for AI agents.

```bash
# Install the full public ForgeCAD skill library (--target claude|opencode for a specific agent)
forgecad skill install

# Or export a single context file for chat UIs (Claude.ai, ChatGPT, ...)
forgecad skill one-file ~/Desktop/forgecad-context.md

# Or export one flattened Markdown file per bundled skill
forgecad skill flattened-files ~/Desktop/forgecad-skills
```

--------------------------------

### Project Root Directory Examples

Source: https://forgecad.io/docs/welcome

Recommended and discouraged directory structures for ForgeCAD project roots.

```text
good:  ~/cad/spool-adapter/
good:  ~/Projects/forgecad/start-here/
bad:   ~/~
bad:   ~/Downloads/
bad:   ~/Projects/
```

--------------------------------

### Verify Local FEA Tooling

Source: https://forgecad.io/docs/structural-fea

Commands to verify the installation of local dependencies required for FEA simulation.

```bash
uv --version
```

```bash
ccx -v
```

```bash
bash --version
```

--------------------------------

### Verify Skill Installation

Source: https://forgecad.io/docs/ai-usage

Prompt the agent to list available ForgeCAD skills to confirm successful installation.

```text
What ForgeCAD skills are available?
```

--------------------------------

### Staged Build Plan Prompt

Source: https://forgecad.io/docs/ai-usage

Use this prompt structure to guide the AI through a systematic, iterative modeling process.

```text
First write a short build plan with parts, parameters, and verification checks.
Then implement the smallest useful, explicitly scoped blockout, run it, render
it, and iterate. Treat that blockout as proportion and relationship evidence
only; add details after the proportions and assembly relationships are correct
and keep readiness claims behind targeted checks.
```

--------------------------------

### ProductSurfaceBuilder.ribbon

Source: https://forgecad.io/docs/curves

Starts a conformal ribbon on the skin side.

```APIDOC
## ProductSurfaceBuilder.ribbon(name: string, points: ProductSurfacePathPoint[], options?: ProductRibbonBuildOptions)

### Description
Starts a conformal ribbon on this skin side. The returned ProductRibbonBuilder is bound to the source skin.

### Parameters
- **name** (string) - Required - Name of the ribbon.
- **points** (ProductSurfacePathPoint[]) - Required - Array of path points using side-local u/v coordinates.
- **options** (ProductRibbonBuildOptions) - Optional - Configuration for ribbon width, thickness, and sampling.
```

--------------------------------

### Install Skills to Specific Targets

Source: https://forgecad.io/docs/ai-usage

Commands to install or update skills for specific agent environments using the --target flag.

```bash
forgecad skill install
forgecad skill install --target claude
forgecad skill install --target codex
forgecad skill install --target opencode
```

--------------------------------

### Create Boundary Surfaces

Source: https://forgecad.io/docs/curves

Examples of creating a closed-rim bowl and a fender panel with G2 curvature continuity.

```javascript
// Smooth closed-rim dished bowl: a closed rim + radial sections, welded.
const bowl = Surface.BoundaryNet()
  .lengthwise(...radialSections)   // rim -> center, one per around-rim station
  .closedV()                       // weld the around-rim seam (no kink)
  .thicken(1.2);
```

```javascript
// Match a fender panel to the hood with curvature (G2) continuity.
const fender = Surface.BoundaryNet()
  .lengthwise(sill, belt, crown)
  .crosswise(nose, aPillar)
  .matchStartV({ edge: hood.rearEdge, continuity: 2 })
  .toSheet();
```

--------------------------------

### High-quality rendering

Source: https://forgecad.io/docs/cli

Performs path-traced rendering using Blender Cycles; requires Blender installed on the system path.

```bash
forgecad render hq model.forge.js
forgecad render hq model.forge.js --output hero.png --preset dramatic --samples 1024
```

--------------------------------

### Run Local FEA Simulation

Source: https://forgecad.io/docs/structural-fea

Executes an FEA simulation using local solver tools. Requires local installation of dependencies like CalculiX.

```bash
forgecad sim fea run bracket.forge.js --provider local
```

--------------------------------

### Locate Installed Skills

Source: https://forgecad.io/docs/ai-usage

The default path where ForgeCAD skills are stored.

```text
~/.agents/skills/forgecad/SKILL.md
```

--------------------------------

### Execute ForgeCAD export and check commands

Source: https://forgecad.io/docs/cli

Examples of common CLI operations for sheet material processing, 3D printing, CAD interchange, technical reporting, and robot simulation.

```bash
# Sheet material
forgecad cut-list shelf.forge.js --param Material=plywood
forgecad export cutting-layout shelf.forge.js --sheet-width 420 --sheet-height 594 --kerf 3
forgecad export cutting-layout shelf.forge.js --output out/layout.dxf

# 3D printing
forgecad check print bracket.forge.js
forgecad export stl bracket.forge.js --param Width=42
forgecad export 3mf bracket.forge.js --quality high
forgecad export variants bracket.forge.js --format stl --vary "Width=36..48:3"

# CAD interchange
forgecad export step bracket.forge.js --param Width=42

# Technical drawings
forgecad export report bracket.forge.js --output out/report.pdf

# Robot simulation
forgecad export sdf rover.forge.js --output out/forge_scout
forgecad export mjcf rover.forge.js --param Wheelbase=180 --output out/forge_scout_mjcf
forgecad export usd rover.forge.js --output out/forge_scout_usd
```

--------------------------------

### Utilize Built-in Material Presets

Source: https://forgecad.io/docs/structural-fea

Accesses pre-defined material properties for common metals and 3D printing filaments. Use these as starting points before substituting with specific datasheet values.

```javascript
const pla = Fea.materials.isotropicPrintedPla();
const printedPla = Fea.materials.printedPla({
  infillPercent: 40,
  layerNormal: [0, 0, 1],
  rasterDirection: [1, 0, 0],
});
const copper = Fea.materials.c11000CopperAnnealed();
const aluminum = Fea.materials.aluminum6061T6();
const steel = Fea.materials.astmA36StructuralSteel();
```

--------------------------------

### Stroking paths into profiles

Source: https://forgecad.io/docs/curves

Examples of converting open polylines into solid profiles using different join styles or direct coordinate arrays.

```typescript
// Square-join L-bracket
const bracket = path().moveTo(0, 0).lineH(50).lineV(-70).lineAngled(20, 235).stroke(4);

// Round-join rib
const rib = path().moveTo(0, 0).lineH(60).stroke(6, 'Round');

// Equivalent standalone form
const wire = stroke([[0, 0], [50, 0], [50, -70]], 4);
```

--------------------------------

### Loft.withGuideRails(stations: LoftStation[], rails: LoftGuideRail[], options?: LoftWithGuideRailsOptions): Shape

Source: https://forgecad.io/docs/curves

Lofts through profile stations while forcing generated sections to follow guide rails.

```APIDOC
## Loft.withGuideRails(stations: LoftStation[], rails: LoftGuideRail[], options?: LoftWithGuideRailsOptions): Shape

### Description
Loft through profile stations while forcing generated sections to follow guide rails. Stations define the cross-section family, and guide rails define the paths the loft must pass through.

### Parameters
- **stations** (LoftStation[]) - Required - The cross-section profiles.
- **rails** (LoftGuideRail[]) - Required - The guide rails for the loft.
- **options** (LoftWithGuideRailsOptions) - Optional - Configuration options including axis, samples, and railSamples.
```

--------------------------------

### Loft.pathOnXz(path: LoftPath2D, y?: number): Vec3[]

Source: https://forgecad.io/docs/curves

Places a 2D guide path onto the XZ plane where the first coordinate becomes X and the second becomes Z.

```APIDOC
## Loft.pathOnXz(path: LoftPath2D, y?: number): Vec3[]

### Description
Places a 2D guide path onto the XZ plane. The path's first coordinate becomes X and its second coordinate becomes Z.

### Parameters
- **path** (LoftPath2D) - Required - The 2D path to project.
- **y** (number) - Optional - The Y coordinate offset.
```

--------------------------------

### Loft.pathOnXy(path: LoftPath2D, z?: number): Vec3[]

Source: https://forgecad.io/docs/curves

Places a 2D guide path onto the XY plane where the first coordinate becomes X and the second becomes Y.

```APIDOC
## Loft.pathOnXy(path: LoftPath2D, z?: number): Vec3[]

### Description
Places a 2D guide path onto the XY plane. The path's first coordinate becomes X and its second coordinate becomes Y.

### Parameters
- **path** (LoftPath2D) - Required - The 2D path to project.
- **z** (number) - Optional - The Z coordinate offset.
```

--------------------------------

### Project Cloning

Source: https://forgecad.io/docs/cli

Initialize a project from a hosted starter template.

```bash
forgecad project clone start-here
cd start-here
forgecad studio .
```

--------------------------------

### Curve.Arc

Source: https://forgecad.io/docs/curves

Creates an exact circular 3D arc from start, end, and start tangent.

```APIDOC
## Curve.Arc(options: CurveArcOptions): NurbsCurve3D

### Description
Create an exact circular 3D arc from start, end, and start tangent. The returned curve is a rational quadratic NurbsCurve3D.

### Parameters
- **options** (CurveArcOptions) - Required - Configuration object containing start point, end point, and start tangent.

### Returns
- **NurbsCurve3D** - The resulting circular arc.
```

--------------------------------

### Train the starter balance policy

Source: https://forgecad.io/docs/simulation-workflow

Executes the training script using uv with the required dependencies.

```bash
cd /tmp/scout-cam-rover-mjcf
uv run --python 3.11 --with mujoco --with numpy --with gymnasium --with pillow python scripts/train_balance.py --render-gif balance.gif --fps 10
```

--------------------------------

### Initialize a new local project

Source: https://forgecad.io/docs/welcome

Commands to create a new project directory, initialize metadata, and scaffold a new part template.

```bash
npm install -g forgecad
mkdir spool-adapter
cd spool-adapter
forgecad project init "Spool Adapter" --visibility private
forgecad new adapter --template part
forgecad studio .
```

--------------------------------

### Run CLI help command

Source: https://forgecad.io/docs/cli

Displays the full list of available commands and flags.

```bash
forgecad  --help
```

--------------------------------

### Clone the ForgeCAD starter project

Source: https://forgecad.io/docs/ai-usage

Initializes the environment and clones the starter project template for AI-assisted development.

```bash
npm install -g forgecad
forgecad login
# Choose email/password or API token when prompted.
forgecad project clone start-here
cd start-here
forgecad studio .
```

--------------------------------

### Create a 3D Arc

Source: https://forgecad.io/docs/curves

Generates a rational quadratic NurbsCurve3D arc defined by start, end, and start tangent.

```javascript
const rail = Curve.Arc({
  start: [40, 0, 0],
  end: [0, 40, 0],
  tangent: [0, 1, 0],
});
const tube = sweep(circle2d(2), rail);
```

--------------------------------

### Create a new ForgeCAD project

Source: https://forgecad.io/docs/ai-usage

Sets up a new project directory and initializes it with a template for CAD generation.

```bash
npm install -g forgecad
mkdir enclosure-bracket
cd enclosure-bracket
forgecad project init "Enclosure Bracket" --visibility private
forgecad new bracket --template part
forgecad studio .
```

--------------------------------

### Multi-file assembly pattern

Source: https://forgecad.io/docs/core

Demonstrates how an assembly file manages parameters and passes them to child builder modules.

```javascript
// assembly.forge.js — owns cross-cutting params, passes to parts
const wall = param("Wall", 3);
const baseH = param("Base Height", 20);

const mountModule = require('./motor-mount.forge.js');
const baseModule = require('./base-body.forge.js');

const mount = mountModule.buildMount({ wall });
const base = baseModule.buildBase({ wall, height: baseH });
```

--------------------------------

### Pushing to Hosted Environment

Source: https://forgecad.io/docs/ai-usage

Commands to deploy the verified project state to the ForgeCAD hosting service.

```bash
forgecad project push
forgecad project open
```

--------------------------------

### Editor and Development Commands

Source: https://forgecad.io/docs/cli

Commands for launching the local studio or development servers.

```bash
studio  [project-path ...]
```

```bash
dev  [project-path ...]
```

```bash
web
```

```bash
forgecad studio 
```

```bash
forgecad dev 
```

```bash
forgecad studio  [project-path ...]
```

--------------------------------

### connectorMeasurements(name: string): Record

Source: https://forgecad.io/docs/core

Get measurements metadata from a connector.

```APIDOC
## connectorMeasurements(name: string)

### Description
Get measurements metadata from a connector.

### Parameters
- **name** (string) - Required - The connector name.
```

--------------------------------

### connectorsByType(type: string): Array

Source: https://forgecad.io/docs/core

Get all connectors of a given type.

```APIDOC
## connectorsByType(type: string)

### Description
Get all connectors of a given type, including from named children.

### Parameters
- **type** (string) - Required - The connector type.
```

--------------------------------

### scene(options)

Source: https://forgecad.io/docs/viewport

Configures the scene environment, including camera, lighting, and background settings.

```APIDOC
## scene(options: SceneOptions): void

### Description
Configures the scene environment for the current script execution. Controls camera, render views, lighting, background, and joint-control helpers. Multiple calls merge settings.

### Parameters
- **options** (SceneOptions) - Required - Configuration object for scene properties like camera, lights, and environment settings.
```

--------------------------------

### Surface.Complex

Source: https://forgecad.io/docs/curves

Starts a named surface complex for building quilts of parametric sheets.

```APIDOC
## Surface.Complex(name)

### Description
Starts a named surface complex: a quilt of numeric parametric sheets with explicit edge joins, continuity-requested bridge patches, and conversion to solids.

### Parameters
- **name** (string) - Optional - The name of the surface complex.
```

--------------------------------

### Generate Comparison Boards with Python

Source: https://forgecad.io/docs/skills/forgecad-reconstruct-from-images

Use the bundled comparison script to create side-by-side images for validating model renders against reference photos.

```bash
uv run <skill-dir>/scripts/compare_images.py refs/front.png render-front.png compare-front.png
```

--------------------------------

### Train a Stable-Baselines3 Policy

Source: https://forgecad.io/docs/simulation-workflow

Executes the training script for the balance environment. Use the --algo flag to switch between PPO and SAC algorithms.

```bash
cd /tmp/scout-cam-rover-mjcf
uv run --python 3.11 --with mujoco --with numpy --with gymnasium --with stable-baselines3 --with pillow python scripts/train_sb3.py \
  --timesteps 50000 \
  --output policies/sb3_balance_ppo.zip \
  --render-gif sb3_balance.gif \
  --fps 10
```

--------------------------------

### Curve.Trim

Source: https://forgecad.io/docs/curves

Extract an exact curve segment from normalized parameter start to end.

```APIDOC
## Curve.Trim(curve: T, start: number, end: number): CurveTrimOutput

### Description
Extract an exact curve segment from normalized parameter start to end. NurbsCurve3D inputs are trimmed with exact knot insertion/subdomain extraction.
```

--------------------------------

### route(x: number, y: number): RouteBuilder

Source: https://forgecad.io/docs/sketch

Start a directional route from coordinates.

```APIDOC
## route(x: number, y: number): RouteBuilder

### Description
Start a directional route from coordinates. Returns a RouteBuilder to describe the path.

### Parameters
- **x** (number) - Required - Start X.
- **y** (number) - Required - Start Y.
```

--------------------------------

### Drive parent assembly controls

Source: https://forgecad.io/docs/assembly

Demonstrates how to drive controls in a parent assembly after merging sub-assemblies using prefixed names.

```javascript
parent.solve({ "Left Arm.theta": 45, "Right Arm.theta": -20 })
```

--------------------------------

### Studio and Dev Flags

Source: https://forgecad.io/docs/cli

Configuration flags for customizing server behavior during development.

```bash
--port 
```

```bash
--host [host]
```

```bash
--open
```

```bash
--strict-port
```

--------------------------------

### ProductSkinBuilder.build

Source: https://forgecad.io/docs/curves

Finalizes the skin construction.

```APIDOC
## ProductSkinBuilder.build()

### Description
Lowers stations and refs into a ProductSkin body.
```

--------------------------------

### Publish a Project Model

Source: https://forgecad.io/docs/cli

Publishes a specific model file to generate a live shareable link.

```bash
forgecad project publish adapter.forge.js --title "AMS Lite Adapter"
```

--------------------------------

### Laser.kit

Source: https://forgecad.io/docs/sheet-metal

Creates a container for a flat-pack project.

```APIDOC
## Laser.kit(options?: LaserKitOptions) -> LaserKit

### Description
Creates a LaserKit container that collects FlatPart instances, generates a bill of materials, nests parts, exports SVG views, and produces kerf-compensated assembly previews.
```

--------------------------------

### Draw Arcs Around Centers

Source: https://forgecad.io/docs/curves

Examples of drawing arcs using absolute and relative center points.

```javascript
// Arc 90° CCW around (50, 50)
path().moveTo(70, 50).arcAround(50, 50, 90)
// Arc 45° CW around the origin
path().moveTo(10, 0).arcAround(0, 0, -45)
```

```javascript
// Arc 90° CCW around a center 20 units to the right
path().moveTo(50, 50).arcAroundRelative(20, 0, 90)
// Equivalent to: path().moveTo(50, 50).arcAround(70, 50, 90)
```

--------------------------------

### Generate helical paths and coils

Source: https://forgecad.io/docs/curves

Creates helical guides or swept coils using pitch, turns, and radius parameters.

```typescript
const guide = Curve.Helix.withPitchAndTurns({ radius: 20, pitch: 6, turns: 4 });
const coil = Curve.Helix.coil({ radius: 20, pitch: 6, turns: 4, wireRadius: 1 });
```

--------------------------------

### SurfaceBody(name)

Source: https://forgecad.io/docs/curves

Starts a surface-member body builder for creating physical members like straps, inlays, and guards on a carrier surface.

```APIDOC
## SurfaceBody(name: string): SurfaceBodyBuilder

### Description
Initializes a builder for creating surface-based physical members that live on a carrier surface.

### Parameters
- **name** (string) - Required - The name of the surface body.
```

--------------------------------

### Perform Tolerance Stack-up Analysis

Source: https://forgecad.io/docs/simulation-workflow

Analyzes manufacturing variations using Monte Carlo simulations on model parameters. Requires verify.* results to be defined in the model.

```bash
node dist-cli/forgecad.js sim tolerance model.forge.js --json
```

--------------------------------

### Build a path with RouteBuilder

Source: https://forgecad.io/docs/sketch

Create a directional path starting from specific coordinates and use the returned entity IDs for further geometric constraints.

```javascript
const r = sk.route(0, 0);
const stem = r.up(18);
r.arcLeft(8.9);
const neck = r.down();
r.done();
sk.offsetX(stem, neck, 10.8);
```

--------------------------------

### Verifying Simple Parts

Source: https://forgecad.io/docs/ai-usage

Standard verification sequence for basic ForgeCAD models.

```bash
forgecad run model.forge.js
forgecad render 3d model.forge.js --camera iso
forgecad check print model.forge.js --json
```

--------------------------------

### ProductRibbonBuilder

Source: https://forgecad.io/docs/curves

Builder for thin trim, label, grip, and split-line features.

```APIDOC
## ProductRibbonBuilder

### Methods
- **on(skin: ProductSkin, points: ProductRibbonPathPoint[], options?: ProductRibbonBuildOptions)**: Follow a ProductSkin with side/u/v path queries.
- **fromRefs(points: ProductSurfaceRef[], options?: ProductRibbonBuildOptions)**: Follow explicit surface refs.
- **width(width: number)**: Set ribbon width in millimeters.
- **thickness(thickness: number)**: Set solid thickness outward.
- **offset(offset: number)**: Set positive clearance between source surface and ribbon.
- **samples(samples: number)**: Set samples along the path.
- **widthSamples(samples: number)**: Set samples across the width.
- **resolution(resolution: number)**: Set NURBS tessellation resolution.
- **material(material: ProductMaterial)**: Apply a product material preset.
- **color(color: string)**: Apply a simple color override.
- **build(options?: ProductRibbonBuildOptions)**: Build a conformal ribbon as a thin NURBS surface solid.
```

--------------------------------

### Agent Prompt: New Model

Source: https://forgecad.io/docs/ai-usage

Prompt for creating a new model with parameterization and validation steps.

```text
Use the ForgeCAD skills. Build a real ForgeCAD model in this project folder.
Create or edit .forge.js files only inside this project. Use parameters for the
main dimensions. Validate with forgecad run, render at least one 3D view, run
forgecad check print for print-focused parts, and push with forgecad project
push when the result is ready for the browser.
```

--------------------------------

### Loft.pathOnYz(path: LoftPath2D, x?: number): Vec3[]

Source: https://forgecad.io/docs/curves

Places a 2D guide path onto the YZ plane where the first coordinate becomes Y and the second becomes Z.

```APIDOC
## Loft.pathOnYz(path: LoftPath2D, x?: number): Vec3[]

### Description
Places a 2D guide path onto the YZ plane. The path's first coordinate becomes Y and its second coordinate becomes Z.

### Parameters
- **path** (LoftPath2D) - Required - The 2D path to project.
- **x** (number) - Optional - The X coordinate offset.
```

--------------------------------

### Parametric Starter Script

Source: https://forgecad.io/docs/welcome

A basic script defining parameters and a simple subtractive geometry operation.

```javascript
const width = Param.number("Width", 90, { min: 50, max: 160, unit: "mm" });
const depth = Param.number("Depth", 56, { min: 32, max: 100, unit: "mm" });
const height = Param.number("Height", 12, { min: 6, max: 32, unit: "mm" });
const holeRadius = Param.number("Hole Radius", 5, { min: 2, max: 10, unit: "mm" });

const base = box(width, depth, height).color("#5f87c6");
const hole = cylinder(height * 3, holeRadius).translate(0, 0, -height);

return {
  "starter plate": base.subtract(hole),
};
```

--------------------------------

### Authentication and Automation

Source: https://forgecad.io/docs/cli

Commands for managing user sessions and CI/CD automation tokens.

```bash
forgecad login
```

```bash
FORGECAD_TOKEN=fc_pat_... forgecad 
```

--------------------------------

### withSimulation(options)

Source: https://forgecad.io/docs/assembly

Attaches the root simulation contract for the assembly.

```APIDOC
## withSimulation(options: SimAssemblySimulationOptions)

### Description
Attach the root simulation contract for this assembly. Used by exporters and simulation checkers to read the assembly's physical profile.

### Parameters
- **options** (SimAssemblySimulationOptions) - Required - Configuration containing profile, rootPart, and controllers.
```

--------------------------------

### ProductSurfaceBuilder.ref

Source: https://forgecad.io/docs/curves

Creates a reference point on a specific product skin side.

```APIDOC
## ProductSurfaceBuilder.ref(u?: number, v?: number, offset?: number)

### Description
Creates a reference on the bound skin side using optional u, v coordinates and an offset distance.

### Parameters
- **u** (number) - Optional - Across-side parameter.
- **v** (number) - Optional - Along-axis parameter.
- **offset** (number) - Optional - Positive distance away from the surface.
```

--------------------------------

### Check Printability

Source: https://forgecad.io/docs/cli

Run automated print readiness checks for collisions, mesh health, and overhangs.

```bash
forgecad check print model.forge.js
forgecad check print model.forge.js other-model.forge.js
```

--------------------------------

### Run Cloud-Backed FEA Simulation

Source: https://forgecad.io/docs/structural-fea

Executes an FEA simulation using the Daytona cloud provider. Requires the DAYTONA_API_KEY environment variable to be set.

```bash
export DAYTONA_API_KEY=...
forgecad sim fea run bracket.forge.js --provider daytona
```

```bash
export FORGECAD_FEA_PROVIDER=daytona
forgecad sim fea run bracket.forge.js
```

--------------------------------

### Execute FEA Workflow in Separate Steps

Source: https://forgecad.io/docs/structural-fea

Use these commands to decouple model preparation from solver execution and rendering.

```bash
forgecad sim fea prepare model.forge.js --output out/beam.feapkg
forgecad sim fea run-from-prepared out/beam.feapkg
forgecad sim fea render out/beam.feapkg --field stress --output out/stress.png
```

--------------------------------

### Wood.board

Source: https://forgecad.io/docs/wood

Creates a new WoodBoard instance with specified dimensions and optional metadata.

```APIDOC
## Wood.board(width, height, thickness, opts?)

### Description
Creates a wood board with metadata for manufacturing. The board is a box centered on XY, with the base at Z=0.

### Parameters
- **width** (number) - Required - Board width (mm) along X.
- **height** (number) - Required - Board height (mm) along Y.
- **thickness** (number) - Required - Board thickness (mm) along Z.
- **opts** (WoodBoardOptions) - Optional - Metadata including grain, species, and material.
```

--------------------------------

### Validate Simulation Readiness

Source: https://forgecad.io/docs/cli

Verify robot and physics metadata before exporting for simulation.

```bash
forgecad check simready model.forge.js
forgecad check simready model.forge.js other-model.forge.js
```

--------------------------------

### View variant export help

Source: https://forgecad.io/docs/cli

Displays help information for the variant export grammar.

```bash
forgecad export variants --help
```

--------------------------------

### List named camera views

Source: https://forgecad.io/docs/cli

Prints all named render views declared in a model file for use in other render commands.

```bash
forgecad render views model.forge.js
forgecad render views model.forge.js reference.step
```

--------------------------------

### connectorNames(): string[]

Source: https://forgecad.io/docs/core

List all connector names.

```APIDOC
## connectorNames()

### Description
List all connector names, including "ChildName.connectorName" from named children.
```

--------------------------------

### Exporting Model Files

Source: https://forgecad.io/docs/ai-usage

Commands to export verified models into various formats.

```bash
forgecad export stl model.forge.js
forgecad export 3mf model.forge.js --quality high
forgecad export step model.forge.js
```

--------------------------------

### scene(options: SceneOptions): void

Source: https://forgecad.io/docs/viewport

Configures the scene environment for the current script execution. This function accepts a configuration object defining the background, camera, views, journeys, lights, and fog settings.

```APIDOC
## scene(options: SceneOptions)

### Description
Configures the scene environment for the current script execution. This function is used to define the visual properties of the 3D scene, including lighting, camera positioning, and interactive journeys.

### Parameters
- **options** (SceneOptions) - Required - Configuration object containing scene settings.

### Request Example
```javascript
scene({
  background: { top: '#000814', bottom: '#001d3d' },
  camera: { position: [160, -120, 100], target: [0, 0, 50], fov: 52 },
  views: {
    hero: { camera: { position: [180, -140, 90], target: [0, 0, 25], fov: 38 } },
  },
  journeys: {
    tour: { steps: [{ id: 'earth', focus: 'Earth', caption: 'Fit and inspect Earth.' }] },
  },
  lights: [
    { type: 'ambient', color: '#001233', intensity: 0.08 },
    { type: 'directional', position: [50, -30, 200], color: '#ffd60a', intensity: 1.2 },
  ],
  fog: { color: '#000814', near: 100, far: 450 },
  jointOverlay: { axisColor: '#13dfff', arcColor: '#ff7a1a' },
});
```
```

--------------------------------

### ForgeCAD CLI Commands

Source: https://forgecad.io/docs/welcome

Commands to execute a script and launch the studio environment.

```bash
forgecad run starter.forge.js
forgecad studio .
```

--------------------------------

### Export SimReady Asset

Source: https://forgecad.io/docs/simready-quickstart

Exports the asset to various simulation formats including MJCF, SDF, URDF, and USD.

```bash
node dist-cli/forgecad.js export mjcf examples/robotics/scout-cam-rover-simready/main.forge.js --output /tmp/rover-mjcf
node dist-cli/forgecad.js export sdf examples/robotics/scout-cam-rover-simready/main.forge.js --output /tmp/rover-sdf
node dist-cli/forgecad.js export urdf examples/robotics/scout-cam-rover-simready/main.forge.js --output /tmp/rover-urdf
node dist-cli/forgecad.js export usd examples/robotics/scout-cam-rover-simready/main.forge.js --output /tmp/rover-usd
```

--------------------------------

### Execute Live Policy Viewer

Source: https://forgecad.io/docs/simulation-workflow

Run a generated passive-viewer script to visualize policy performance in an interactive window, specifically using mjpython on macOS.

```bash
cd /tmp/scout-cam-rover-mjcf
uv run --python 3.11 --with mujoco --with numpy --with gymnasium --with stable-baselines3 mjpython scripts/live_policy_viewer.py \
  --policy policies/sb3_balance_ppo.zip
```

--------------------------------

### assembly(name?: string)

Source: https://forgecad.io/docs/assembly

Creates an assembly container for managing parts, connectors, and kinematic links.

```APIDOC
## assembly(name?: string)

### Description
Create an assembly container with named parts, connectors, and kinematic links. Use this for any model with moving parts.

### Parameters
- **name** (string) - Optional - Name of the assembly.

### Methods
- **link(name, options)**: Define a point in the kinematic graph.
- **edgeBetweenLinks(linkA, linkB, options)**: Define a kinematic edge.
- **addAngleBetweenLinks(linkA, linkB, linkC, options)**: Define an angular constraint.
- **addPart(name, part, options)**: Place geometry on the solved link graph.
```

--------------------------------

### Importing External Geometry Files

Source: https://forgecad.io/docs/core

Demonstrates importing various 3D file formats including meshes with specific object selection and coordinate frame adjustments.

```javascript
const all = Import.mesh("./assembly.3mf", { separateObjects: true });
const pin = all.child("Pin #001");
const plate = Import.mesh("./assembly.3mf", { object: "3mf:build:001:object:7" });
const yUpPart = Import.mesh("./part.obj", { sourceFrame: { up: "+Y" } });
```

--------------------------------

### Render target-focused viewports

Source: https://forgecad.io/docs/cli

Generate a PNG render of the entire scene or a specific target object.

```bash
forgecad show model.forge.js
forgecad show model.forge.js --target Bench
```

--------------------------------

### Run FEA Simulation

Source: https://forgecad.io/docs/structural-fea

Executes an FEA study using the specified provider.

```bash
forgecad sim fea run examples/analysis/structural-stress-fea.forge.js --provider daytona
```

```bash
forgecad sim fea run bracket.forge.js --provider daytona --study side-load
```

--------------------------------

### Configure Force and Torque Parameters

Source: https://forgecad.io/docs/simulation-workflow

Additional command-line arguments for applying directional forces or torques during policy evaluation.

```bash
--push-x 2
--push-y -4
--push-z 1
--torque-x 0.1
--torque-y -0.1
--torque-z 0.1
```

--------------------------------

### Agent Prompt: Mechanism Or Assembly

Source: https://forgecad.io/docs/ai-usage

Prompt for building multi-part assemblies using connectors and metadata.

```text
Use forgecad-build-model and forgecad. For multi-part assemblies, parts must
build at origin, expose connectors/metadata, and let the parent assembly position
them with connectors or matchTo(). Validate with forgecad run, inspect physical
components, inspect fit interference and visual objects, and run parameter
checks before calling it done.
```

--------------------------------

### connect(parentConnectorRef: string, childConnectorRef: string, options?: ConnectOptions)

Source: https://forgecad.io/docs/assembly

Connects two parts by aligning their declared connectors to create a joint.

```APIDOC
## connect(parentConnectorRef: string, childConnectorRef: string, options?: ConnectOptions)

### Description
Connects two parts by aligning their declared connectors, automatically computing frame and axis based on connector geometry.

### Parameters
- **parentConnectorRef** (string) - Required - Reference to the parent connector.
- **childConnectorRef** (string) - Required - Reference to the child connector.
- **options** (ConnectOptions) - Optional - Configuration for the joint, including limits, alignment, and following behavior.
```

--------------------------------

### Forge-aware builder module pattern

Source: https://forgecad.io/docs/core

Uses require.main to conditionally return preview geometry when a module is executed directly.

```javascript
// profiles.forge.js
function wheelProfile() {
  return circle2d(40).subtract(circle2d(18));
}

if (require.main === module) {
  return [{ name: 'Wheel profile', sketch: wheelProfile() }];
}

return { wheelProfile };

// main.forge.js
const profiles = require('./profiles.forge.js');
const wheel = profiles.wheelProfile().extrude(8);
```

--------------------------------

### Inspect model evidence

Source: https://forgecad.io/docs/cli

Use these commands to verify specific aspects of a model, such as construction history or design traces.

```bash
forgecad inspect history main.forge.js --object "Left Leg" --level object
forgecad inspect design-trace main.forge.js --query feature:hole
```

--------------------------------

### Resolve and Manage Face Labels

Source: https://forgecad.io/docs/core

Demonstrates how to label edges and faces during shape creation and how to handle label collisions using prefixes.

```javascript
// Edge labels become side face names after extrude
const profile = path()
  .moveTo(0, 0)
  .lineTo(100, 0).label('floor')
  .lineTo(100, 50).label('wall')
  .lineTo(0, 50).label('ceiling')
  .closeLabel('left-wall');
const room = profile.extrude(30, { labels: { start: 'base', end: 'top' } });
room.face('floor');   // side face from the labeled edge
room.face('base');    // base cap (user-specified)

// .labelEdges() shorthand for sequential edge labeling
const plate = rect(100, 50).labelEdges('south', 'east', 'north', 'west');
const solid = plate.extrude(20, { labels: { start: 'bottom', end: 'top' } });
solid.face('south'); // side face

// Prefix before combining to avoid collisions
const left = wing.prefixLabels('l/');
const right = wing.mirror([1, 0, 0]).prefixLabels('r/');
const full = union(left, right);
full.face('l/upper'); // left wing upper surface
```

--------------------------------

### Param.string(name, defaultValue, opts?)

Source: https://forgecad.io/docs/concepts

Declares a string parameter that renders as a text input in the UI.

```APIDOC
## Param.string(name, defaultValue, opts?)

### Description
Declares a string parameter that renders as a text input in the UI.

### Parameters
- **name** (string) - Required - The identifier for the parameter.
- **defaultValue** (string) - Required - The initial value.
- **opts** (object) - Optional - Configuration options.
```

--------------------------------

### LaserKit Interface

Source: https://forgecad.io/docs/sheet-metal

Manages a collection of flat parts, providing tools for nesting, BOM generation, and assembly visualization.

```APIDOC
## LaserKit

### Description
Manages a kit of sheet metal parts. Handles registration, nesting for manufacturing, and assembly visualization.

### Methods
- **addPart(part: FlatPart, overrides?: { qty?: number; }): this** - Register a part to the kit.
- **cutSheets(): CuttingLayoutResult** - Generate nested cut sheets.
- **bom(): LaserKitBomEntry[]** - Generate a bill of materials.
- **assemblyPreview(options?: AssemblyPreviewOptions): AssemblyPreviewResult** - Generate a 3D fold-up preview.
- **assemblyInstructions(options?: AssemblyInstructionsOptions): AssemblyInstructionsResult** - Generate step-by-step assembly instructions.
```

--------------------------------

### matchStartU(condition: BoundaryCondition)

Source: https://forgecad.io/docs/core

Enforce a continuity condition on the u = 0 (left) boundary.

```APIDOC
## matchStartU(condition: BoundaryCondition)

### Description
Enforce a continuity condition on the u = 0 (left) boundary. Pass an edge to match an adjacent sheet's tangent or curvature, or a tangent to impose an explicit cross-boundary direction.

### Parameters
- **condition** (BoundaryCondition) - Required - The boundary condition object containing edge, tangent, tangentScale, or continuity settings.
```

--------------------------------

### Inspect Model with MuJoCo Viewer

Source: https://forgecad.io/docs/simulation-workflow

Use the standalone viewer to inspect robot geometry, joints, and dynamics defined in an MJCF file.

```bash
uv run --python 3.11 --with mujoco python -m mujoco.viewer --mjcf=scene.xml
```

--------------------------------

### Create 2D paths with PathBuilder

Source: https://forgecad.io/docs/sketch

Construct 2D profiles using line segments and labels for downstream face references.

```javascript
// Closed triangle
const triangle = path().moveTo(0, 0).lineH(50).lineV(30).close();

// L-shaped bracket as a stroke
const bracket = path().moveTo(0, 0).lineH(50).lineV(-70).lineAngled(20, 235).stroke(4);

// Labeled edges for downstream face references
const slot = path()
  .moveTo(0, 0)
  .lineTo(30, 0).label('bottom')
  .lineTo(30, 10)
  .lineTo(0, 10).label('top')
  .close();
```

--------------------------------

### Export and Run Pinocchio Dynamics

Source: https://forgecad.io/docs/simulation-workflow

Commands to export a ForgeCAD model to Pinocchio, execute the simulation harness, and read back the dynamics feedback.

```bash
node dist-cli/forgecad.js export pinocchio model.forge.js --output out/robot_pinocchio
cd out/robot_pinocchio && uv run --python 3.11 --with pin --with numpy python scripts/run_pinocchio.py
node dist-cli/forgecad.js sim dynamics out/robot_pinocchio
```

--------------------------------

### lib.bracket

Source: https://forgecad.io/docs/lib

Creates an L-shaped mounting bracket with optional through-holes.

```APIDOC
## lib.bracket(width: number, height: number, depth: number, thick: number, holeDia?: number): Shape

### Description
Produces a right-angle bracket with a horizontal base plate and a vertical wall.
```

--------------------------------

### Wood Part Library

Source: https://forgecad.io/docs/concepts

Parametric part generation and joinery methods for woodworking.

```APIDOC
## Wood.board(width, height, thickness, opts?)

### Description
Create a wood board with metadata for manufacturing.

## Wood.dado(host, guest, opts)

### Description
Cut a dado (channel) across the face of a host board for a guest board to sit in.

## Wood.rabbet(board, opts)

### Description
Cut a rabbet (L-shaped step) along an edge of a board.

## Wood.mortiseAndTenon(mortiseBoard, tenonBoard, opts?)

### Description
Cut a mortise in one board and shape a tenon on another.
```

--------------------------------

### ProductPanelBuilder

Source: https://forgecad.io/docs/curves

Builder for defining and attaching product panels.

```APIDOC
## ProductPanelBuilder

### Methods
- **rounded(width: number, height: number, radius?: number)**: Use a rounded rectangle panel profile.
- **oval(width: number, height: number)**: Use an oval panel profile.
- **profile(profile: Sketch)**: Use a custom 2D panel profile.
- **thickness(thickness: number)**: Set panel extrusion thickness.
- **material(material: ProductMaterial)**: Apply a product material preset.
- **color(color: string)**: Apply a simple color override.
- **build()**: Build the panel in local coordinates.
- **attachTo(ref: ProductRefInput, options?: ProductPanelAttachOptions)**: Build and attach this panel to a ProductSurfaceRef.
```

--------------------------------

### require(path: string)

Source: https://forgecad.io/docs/core

Imports a ForgeCAD or helper module. Returns the value exported by the script, with special handling for Assembly objects.

```APIDOC
## require(path: string)

### Description
Imports a ForgeCAD (.forge.js) or helper module. When importing a .forge.js file, returned Assemblies are wrapped as ImportedAssembly objects to preserve state across file boundaries.

### Parameters
- **path** (string) - Required - The relative path to the module, including the file extension (e.g., "./part.forge.js").

### Returns
- **any** - The value returned by the module script.
```

--------------------------------

### Declare 2D path parameters

Source: https://forgecad.io/docs/core

Creates an editable 2D path UI for defining profiles or outlines.

```javascript
const outline = Param.path2d("Bracket Outline", [
  [-40, -20],
  [40, -20],
  [36, 24],
  [-30, 28],
], {
  closed: true,
  anchor: Param.anchor.sheetOnXY([0, 0, 8], { label: "Bracket outline" }),
});

return outline.toSketch().filletCorners(4).extrude(5);
```

--------------------------------

### Validate SimReady Asset

Source: https://forgecad.io/docs/simready-quickstart

Runs the offline gate to check the asset configuration before export.

```bash
node dist-cli/forgecad.js check simready examples/robotics/scout-cam-rover-simready/main.forge.js
```

--------------------------------

### Execute ForgeCAD CLI commands

Source: https://forgecad.io/docs/welcome

Common CLI commands for running, rendering, inspecting, and managing ForgeCAD projects.

```bash
forgecad run adapter.forge.js
forgecad render 3d adapter.forge.js --camera iso
forgecad inspect fit interference adapter.forge.js --camera iso --force
forgecad inspect manufacture thickness adapter.forge.js --min 1.6 --warn 2.4 --camera iso --force
forgecad check print adapter.forge.js --json
forgecad project push
forgecad project open
```

--------------------------------

### Utility Functions

Source: https://forgecad.io/docs/sdf

Advanced utilities for custom SDF creation and combination.

```APIDOC
## Utility Functions

### fromFunction(fn: SdfFunctionSource, options: SdfFunctionOptions): SdfShape
Create a custom SDF from one expression.

### combine(value: unknown, options?: CombineOptions): SdfShape
Collapse a plain object/array tree of SDF leaves into one continuous implicit field.
```

--------------------------------

### PhysicalProperties.exact

Source: https://forgecad.io/docs/concepts

Requests an exact BREP physical-property report.

```APIDOC
## PhysicalProperties.exact(_target, _options?)

### Description
Request an exact BREP physical-property report; currently throws instead of falling back to mesh approximation.

### Parameters
- **_target** (object) - Required - The shape to analyze.
- **_options** (object) - Optional - Additional configuration options.
```
Tokens:
Raw