forgecad 0.9.14 → 0.9.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +6 -4
- package/README.md +8 -4
- package/dist/assets/{AdminPage-eWGs2K6H.js → AdminPage-CDyGUinA.js} +2 -2
- package/dist/assets/{BenchmarkPage-CTrLKfpo.js → BenchmarkPage-DfPMY_-d.js} +4 -15
- package/dist/assets/{BlogPage-5nPesyds.js → BlogPage-kF0fkdJT.js} +2 -2
- package/dist/assets/{DocsPage-C4Y3nbYc.js → DocsPage-B954L3YN.js} +9 -3
- package/dist/assets/EditorApp-Beb-IZ0y.js +14014 -0
- package/dist/assets/{EditorApp-BAnckbsk.css → EditorApp-CuDLxKqL.css} +698 -0
- package/dist/assets/{EmbedViewer-C8fB4n5U.js → EmbedViewer-C77B-TrF.js} +3 -3
- package/dist/assets/{LandingPageProofDriven-jSz0LaMM.js → LandingPageProofDriven-Cr6fXMDj.js} +35 -37
- package/dist/assets/LegalPage-BRlScr9A.css +91 -0
- package/dist/assets/LegalPage-Dzklqmmg.js +39 -0
- package/dist/assets/{PricingPage-BMedqFef.css → PricingPage-BPF6HKyO.css} +25 -0
- package/dist/assets/{PricingPage-B83B90zh.js → PricingPage-zWXkvlwl.js} +19 -19
- package/dist/assets/{SettingsPage-DY889pcu.js → SettingsPage-Bz0of4KQ.js} +2 -2
- package/dist/assets/app-CE3sYcV7.css +3890 -0
- package/dist/assets/{app-bEww1ic4.js → app-D3kDkggg.js} +2293 -946
- package/dist/assets/cli/{render-Cho2uKG_.js → render-DSY3mMQa.js} +337 -7
- package/dist/assets/{constructionHistoryWorker-HYwzJY4m.js → constructionHistoryWorker-gpDo-uH2.js} +927 -243
- package/dist/assets/{evalWorker-CjQwJSE-.js → evalWorker-CU0Ke6DP.js} +7800 -4164
- package/dist/assets/{forgecad_geometry-CH2nvuLA.js → forgecad_geometry-Dgceylq9.js} +43 -1
- package/dist/assets/forgecad_geometry_bg-dD4RNQF1.wasm +0 -0
- package/dist/assets/{inspectWorker-DeRnMVv1.js → inspectWorker-COyp8XXA.js} +927 -243
- package/dist/assets/{javascript-70-4uGcz.js → javascript-1kQXfVaz.js} +1 -1
- package/dist/assets/landing-proof-driven-DiGqdtWa.js +18 -0
- package/dist/assets/{landing-proof-driven-oFYW6mjz.css → landing-proof-driven-ORyigZ6p.css} +13 -7
- package/dist/assets/legalContent-ZfFGMmi4.js +251 -0
- package/dist/assets/{manifold-CG9Fokx-.js → manifold-BRI5prcH.js} +1 -1
- package/dist/assets/{manifold-uRzgk5O8.js → manifold-C-3h2M7p.js} +2 -2
- package/dist/assets/{manifold-rmfAcdwF.js → manifold-DNkrUWpA.js} +1 -1
- package/dist/assets/{reportWorker-4cW_ZpoS.js → reportWorker-CdBz5bNg.js} +7538 -10857
- package/dist/assets/{scalar-sampling-budget-CfDiFvh7.js → scalar-sampling-budget-wJF98aY9.js} +6935 -4331
- package/dist/assets/{scanProxyWorker-Bs2TDgLw.js → scanProxyWorker-B-9VbLIs.js} +32 -1
- package/dist/assets/{solver-DuJAO8S6.js → solver-BZ9LPTHs.js} +1 -1
- package/dist/assets/solver_bg-DAHZJ_rw.wasm +0 -0
- package/dist/assets/{targets-D6PWsv6X.js → targets-B9sGB5nB.js} +1 -1
- package/dist/assets/{vendor-react-Da3A2QmU.js → vendor-react-6j1Kke-Y.js} +6 -5
- package/dist/cli/render.html +1 -1
- package/dist/docs/index.html +2 -2
- package/dist/docs-raw/AI/ai-native-cad.md +50 -0
- package/dist/docs-raw/AI/usage.md +3 -12
- package/dist/docs-raw/CLI.md +30 -10
- package/dist/docs-raw/component-model.md +27 -11
- package/dist/docs-raw/generated/assembly.md +301 -212
- package/dist/docs-raw/generated/concepts.md +235 -237
- package/dist/docs-raw/generated/core.md +283 -6
- package/dist/docs-raw/generated/curves.md +274 -361
- package/dist/docs-raw/generated/lib.md +7 -1
- package/dist/docs-raw/generated/output.md +19 -4
- package/dist/docs-raw/generated/runtime-names.md +41 -0
- package/dist/docs-raw/generated/sdf.md +31 -0
- package/dist/docs-raw/generated/sheet-metal.md +9 -0
- package/dist/docs-raw/generated/sketch.md +44 -1
- package/dist/docs-raw/generated/viewport.md +11 -3
- package/dist/docs-raw/guides/coordinate-system.md +20 -16
- package/dist/docs-raw/guides/geometry-conventions.md +2 -2
- package/dist/docs-raw/guides/inspection-bundles.md +2 -1
- package/dist/docs-raw/guides/joint-design.md +24 -0
- package/dist/docs-raw/guides/positioning.md +13 -3
- package/dist/docs-raw/legal/privacy.md +63 -0
- package/dist/docs-raw/legal/software-license.md +55 -0
- package/dist/docs-raw/legal/terms.md +87 -0
- package/dist/docs-raw/skills/forgecad-3d-reconstruction.md +1 -1
- package/dist/docs-raw/skills/forgecad-blockout-model.md +1 -1
- package/dist/docs-raw/skills/forgecad-component-model.md +11 -2
- package/dist/docs-raw/skills/forgecad-high-level-spec.md +1 -1
- package/dist/docs-raw/skills/forgecad-image-replicator.md +8 -8
- package/dist/docs-raw/skills/forgecad-lld.md +1 -1
- package/dist/docs-raw/skills/forgecad-make-a-model.md +1 -1
- package/dist/docs-raw/skills/forgecad-model-grader.md +2 -2
- package/dist/docs-raw/skills/forgecad-prepare-prompt.md +2 -2
- package/dist/docs-raw/skills/forgecad-project.md +1 -1
- package/dist/docs-raw/skills/forgecad-reconstruction-benchmark.md +1 -1
- package/dist/docs-raw/skills/forgecad-render-inspect.md +4 -2
- package/dist/docs-raw/skills/forgecad-visual-spec.md +1 -1
- package/dist/docs-raw/skills/forgecad.md +4 -3
- package/dist/index.html +40 -12
- package/dist/llms.txt +8 -0
- package/dist/site.webmanifest +1 -1
- package/dist/sitemap.xml +49 -13
- package/dist-cli/{check-compiler-U5SOPN7X.js → check-compiler-SDX5QIXI.js} +1 -2
- package/dist-cli/{check-query-propagation-XOKNSSYU.js → check-query-propagation-EAYEFT77.js} +1 -2
- package/dist-cli/{chunk-EXWGNL6K.js → chunk-N4O47JLF.js} +12540 -9046
- package/dist-cli/forgecad.js +1786 -679
- package/dist-cli/{forgecad_geometry-GYVNKPIE.js → forgecad_geometry-QOQIIP53.js} +42 -1
- package/dist-cli/forgecad_geometry_bg.wasm +0 -0
- package/dist-cli/{solver-46FFSK2U.js → solver-OK4HECRH.js} +0 -1
- package/dist-cli/solver_bg.wasm +0 -0
- package/dist-skill/CONTEXT.md +1117 -721
- package/dist-skill/SKILL.md +3 -2
- package/dist-skill/docs/API/core/concepts.md +64 -1
- package/dist-skill/docs/CLI.md +30 -10
- package/dist-skill/docs/generated/assembly.md +277 -229
- package/dist-skill/docs/generated/core.md +283 -6
- package/dist-skill/docs/generated/curves.md +272 -362
- package/dist-skill/docs/generated/lib.md +7 -1
- package/dist-skill/docs/generated/output.md +19 -4
- package/dist-skill/docs/generated/runtime-names.md +41 -0
- package/dist-skill/docs/generated/sdf.md +31 -0
- package/dist-skill/docs/generated/sheet-metal.md +9 -0
- package/dist-skill/docs/generated/sketch.md +44 -2
- package/dist-skill/docs/generated/viewport.md +2 -87
- package/dist-skill/docs/guides/coordinate-system.md +20 -16
- package/dist-skill/docs/guides/geometry-conventions.md +2 -2
- package/dist-skill/docs/guides/inspection-bundles.md +2 -1
- package/dist-skill/docs/guides/joint-design.md +24 -0
- package/dist-skill/docs/guides/positioning.md +13 -3
- package/dist-skill/library/forgecad-component-model/SKILL.md +10 -1
- package/dist-skill/library/forgecad-image-replicator/SKILL.md +6 -6
- package/dist-skill/library/forgecad-image-replicator/scripts/compare_images.py +166 -0
- package/dist-skill/library/forgecad-model-grader/SKILL.md +1 -1
- package/dist-skill/library/forgecad-prepare-prompt/SKILL.md +1 -1
- package/dist-skill/library/forgecad-render-inspect/SKILL.md +3 -1
- package/examples/api/assembly-kinematics-foundation.forge.js +65 -0
- package/examples/api/assembly-kinematics-four-bar.forge.js +115 -0
- package/examples/api/assembly-kinematics-limb.forge.js +116 -0
- package/examples/api/connector-frame-rig-chain.forge.js +102 -0
- package/examples/api/exact-sheet-shell-assembly.forge.js +0 -2
- package/examples/api/exact-surface-studio.forge.js +6 -8
- package/examples/api/helix-basics.forge.js +6 -6
- package/examples/api/lean-foundations/README.md +12 -0
- package/examples/api/lean-foundations/curve-blend-exact.forge.js +22 -0
- package/examples/api/lean-foundations/curve-fit-interpolation.forge.js +18 -0
- package/examples/api/lean-foundations/curve-helix-canonicalization.forge.js +27 -0
- package/examples/api/lean-foundations/curve-route-canonicalization.forge.js +16 -0
- package/examples/api/lean-foundations/curve-trim-reverse.forge.js +24 -0
- package/examples/api/lean-foundations/exact-curve-arc.forge.js +36 -0
- package/examples/api/mixed-edge-finishes-proof.forge.js +8 -11
- package/examples/api/route3d-elbow.forge.js +68 -0
- package/examples/api/transition-curves.forge.js +44 -15
- package/examples/api/y-blend-corner-showcase.forge.js +0 -2
- package/examples/generative/coral-vase.forge.js +1 -1
- package/examples/nurbs-tube.forge.js +1 -1
- package/package.json +14 -13
- package/dist/assets/EditorApp-lXv53A1m.js +0 -13610
- package/dist/assets/app-CsHnaBWt.css +0 -1789
- package/dist/assets/forgecad_geometry_bg-C5_E9Oa9.wasm +0 -0
- package/dist/assets/solver_bg-CWvv4lnN.wasm +0 -0
- package/dist/docs-raw/API/README.md +0 -16
- package/dist/docs-raw/API/core/concepts.md +0 -118
- package/dist/docs-raw/INDEX.md +0 -138
- package/dist/docs-raw/RELEASING.md +0 -87
- package/dist/docs-raw/agent-native-api.md +0 -27
- package/dist/docs-raw/beta-deployment.md +0 -304
- package/dist/docs-raw/beta-operations.md +0 -325
- package/dist/docs-raw/blueprint-first.md +0 -145
- package/dist/docs-raw/cli-monetization.md +0 -112
- package/dist/docs-raw/coding-best-practices.md +0 -120
- package/dist/docs-raw/coding.md +0 -340
- package/dist/docs-raw/deployment.md +0 -374
- package/dist/docs-raw/guides/skill-maintenance.md +0 -161
- package/dist/docs-raw/guides/surface-members.md +0 -82
- package/dist/docs-raw/harbor-cli.md +0 -854
- package/dist/docs-raw/internals/backend-vocabulary.md +0 -35
- package/dist/docs-raw/internals/compiler.md +0 -307
- package/dist/docs-raw/internals/constraint-solver-quality.md +0 -161
- package/dist/docs-raw/internals/constraint-solver.md +0 -176
- package/dist/docs-raw/internals/shape-from-slices.md +0 -152
- package/dist/docs-raw/internals/sketch-2d-pipeline.md +0 -108
- package/dist/docs-raw/platform/admin.md +0 -45
- package/dist/docs-raw/platform/architecture.md +0 -82
- package/dist/docs-raw/platform/auth.md +0 -139
- package/dist/docs-raw/platform/email.md +0 -67
- package/dist/docs-raw/platform/google-oauth-setup.md +0 -88
- package/dist/docs-raw/platform/observability.md +0 -197
- package/dist/docs-raw/platform/projects.md +0 -111
- package/dist/docs-raw/platform/sharing.md +0 -90
- package/dist/docs-raw/product/README.md +0 -39
- package/dist/docs-raw/product/api-as-product-language.md +0 -13
- package/dist/docs-raw/product/business-model.md +0 -15
- package/dist/docs-raw/product/competitive-positioning.md +0 -17
- package/dist/docs-raw/product/creative-manufacturing.md +0 -15
- package/dist/docs-raw/product/founder-story.md +0 -11
- package/dist/docs-raw/product/manufacturing-workflows.md +0 -15
- package/dist/docs-raw/product/onboarding-first-experience.md +0 -256
- package/dist/docs-raw/product/product-loop.md +0 -17
- package/dist/docs-raw/product/strategic-decisions.md +0 -22
- package/dist/docs-raw/product/user-outreach-email-templates.md +0 -161
- package/dist/docs-raw/product/user-segments.md +0 -15
- package/dist/docs-raw/product/vision.md +0 -26
- package/dist/docs-raw/rl-environments.md +0 -350
- package/dist/docs-raw/runbook.md +0 -611
- package/dist-cli/check-compiler-U5SOPN7X.js.map +0 -1
- package/dist-cli/check-query-propagation-XOKNSSYU.js.map +0 -1
- package/dist-cli/chunk-EXWGNL6K.js.map +0 -1
- package/dist-cli/forgecad.js.map +0 -1
- package/dist-cli/forgecad_geometry-GYVNKPIE.js.map +0 -1
- package/dist-cli/solver-46FFSK2U.js.map +0 -1
- package/dist-skill/SKILL-dev.md +0 -145
- package/dist-skill/docs-dev/API/core/concepts.md +0 -118
- package/dist-skill/docs-dev/CLI.md +0 -677
- package/dist-skill/docs-dev/agent-native-api.md +0 -27
- package/dist-skill/docs-dev/blueprint-first.md +0 -145
- package/dist-skill/docs-dev/coding-best-practices.md +0 -120
- package/dist-skill/docs-dev/coding.md +0 -340
- package/dist-skill/docs-dev/component-model.md +0 -164
- package/dist-skill/docs-dev/generated/assembly.md +0 -794
- package/dist-skill/docs-dev/generated/core.md +0 -2117
- package/dist-skill/docs-dev/generated/curves.md +0 -2583
- package/dist-skill/docs-dev/generated/lib.md +0 -169
- package/dist-skill/docs-dev/generated/output.md +0 -247
- package/dist-skill/docs-dev/generated/sdf.md +0 -446
- package/dist-skill/docs-dev/generated/sheet-metal.md +0 -504
- package/dist-skill/docs-dev/generated/sketch.md +0 -1811
- package/dist-skill/docs-dev/generated/viewport.md +0 -585
- package/dist-skill/docs-dev/generated/wood.md +0 -108
- package/dist-skill/docs-dev/guides/coordinate-system.md +0 -46
- package/dist-skill/docs-dev/guides/geometry-conventions.md +0 -52
- package/dist-skill/docs-dev/guides/inspection-bundles.md +0 -485
- package/dist-skill/docs-dev/guides/joint-design.md +0 -78
- package/dist-skill/docs-dev/guides/modeling-recipes.md +0 -78
- package/dist-skill/docs-dev/guides/positioning.md +0 -161
- package/dist-skill/docs-dev/guides/skill-maintenance.md +0 -161
- package/dist-skill/docs-dev/internals/backend-vocabulary.md +0 -35
- package/dist-skill/docs-dev/internals/compiler.md +0 -307
- package/dist-skill/docs-dev/internals/constraint-solver-quality.md +0 -161
- package/dist-skill/docs-dev/internals/constraint-solver.md +0 -176
- package/dist-skill/docs-dev/internals/sketch-2d-pipeline.md +0 -108
- package/dist-skill/library/forgecad-image-replicator/scripts/compare_images.mjs +0 -289
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# AI-Native CAD Workflow
|
|
2
|
+
|
|
3
|
+
ForgeCAD is an AI-native CAD workflow for turning product ideas into editable, manufacturable parametric models. The core loop is simple: describe the goal, let an AI agent edit `.forge.js` source, validate the model with the CLI, inspect visual and manufacturing evidence, then revise or fork the next iteration.
|
|
4
|
+
|
|
5
|
+
The important distinction is that ForgeCAD does not stop at a pretty mesh. The model remains code. A hole can move, a wall can thicken, a fastener can change, and a product variant can branch from the same source instead of starting over.
|
|
6
|
+
|
|
7
|
+
## What AI-Driven CAD Means Here
|
|
8
|
+
|
|
9
|
+
AI-driven CAD should produce a model that can survive feedback. In ForgeCAD, the agent works with normal files, not a hidden binary state:
|
|
10
|
+
|
|
11
|
+
- `.forge.js` files express dimensions, parameters, assemblies, connectors, materials, and export intent.
|
|
12
|
+
- `forgecad run` catches syntax errors, import problems, invalid geometry, collisions, and verification failures.
|
|
13
|
+
- `forgecad render` and `forgecad inspect` create visual evidence for design review, fit checks, wall thickness, sections, masks, depth, and normals.
|
|
14
|
+
- `forgecad export` sends the same source toward STL, 3MF, STEP, reports, cutting layouts, robot packages, or G-code depending on the job.
|
|
15
|
+
|
|
16
|
+
This makes the AI useful after the first answer. You can ask for changes in natural language, but the artifact being changed is still an editable engineering object.
|
|
17
|
+
|
|
18
|
+
## Manufacturing Feedback Loop
|
|
19
|
+
|
|
20
|
+
A manufacturable model needs feedback before fabrication. ForgeCAD gives agents a concrete loop:
|
|
21
|
+
|
|
22
|
+
```text
|
|
23
|
+
prompt -> edit source -> run -> render -> inspect -> fix -> export
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
That loop is where quality improves. The agent can inspect collision reports, check thin walls, render multiple camera views, test parameter ranges, and produce evidence for the user instead of relying on a single screenshot.
|
|
27
|
+
|
|
28
|
+
## Parallel Product Idea Iterations
|
|
29
|
+
|
|
30
|
+
Because ForgeCAD models are source files, parallel product exploration is cheap. An agent can create several variants in separate files or branches:
|
|
31
|
+
|
|
32
|
+
- one concept optimized for 3D printing
|
|
33
|
+
- one concept aimed at sheet metal or laser cutting
|
|
34
|
+
- one concept with purchased hardware and service access
|
|
35
|
+
- one simplified blockout for proportion and motion review
|
|
36
|
+
- one production-facing version with clearer tolerances and export targets
|
|
37
|
+
|
|
38
|
+
Each variant can keep the same validation contract: run it, render it, inspect it, compare it, and decide whether it deserves more detail.
|
|
39
|
+
|
|
40
|
+
## Where ForgeCAD Fits
|
|
41
|
+
|
|
42
|
+
ForgeCAD is useful when you want AI-assisted CAD that remains inspectable and editable:
|
|
43
|
+
|
|
44
|
+
- founders exploring physical product ideas
|
|
45
|
+
- makers iterating 3D printed parts and fixtures
|
|
46
|
+
- engineers prototyping mechanisms, enclosures, brackets, and assemblies
|
|
47
|
+
- teams that want version-controlled CAD source and reproducible exports
|
|
48
|
+
- AI agents that need a deterministic toolchain instead of a purely visual prompt-to-mesh path
|
|
49
|
+
|
|
50
|
+
The goal is not to hide CAD behind a chatbot. The goal is to let AI do more of the modeling work while ForgeCAD keeps the result grounded in readable source, validation evidence, and manufacturing outputs.
|
|
@@ -103,15 +103,6 @@ If you only want the core modeling skill without companion workflows:
|
|
|
103
103
|
forgecad skill install --core-only
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
-
ForgeCAD developers can install the internal/development variant of the core skill:
|
|
107
|
-
|
|
108
|
-
```bash
|
|
109
|
-
forgecad skill install --dev
|
|
110
|
-
forgecad skill install --dev --target claude
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
Use `--dev` only for work on ForgeCAD itself. It includes compiler internals, solver architecture, coding standards, release process, and skill maintenance notes.
|
|
114
|
-
|
|
115
106
|
## Recommended Agent Prompts
|
|
116
107
|
|
|
117
108
|
Start the agent inside the initialized project folder. Do not ask it to create a model in a random empty folder or to work from one loose file on the desktop.
|
|
@@ -174,7 +165,7 @@ Do not accept a model just because it renders. CAD quality comes from command ev
|
|
|
174
165
|
|
|
175
166
|
- `forgecad run` confirms the script executes and reports the fast inner-loop build summary.
|
|
176
167
|
- `forgecad render 3d` gives visual views from deterministic cameras.
|
|
177
|
-
- `forgecad inspect <family> <mode>` checks focused geometry evidence such as fit interference, manufacture thickness, visual objects, surface zebra, physical components, and precise or dense section slices.
|
|
168
|
+
- `forgecad inspect <family> <mode>` checks focused geometry evidence such as fit interference, manufacture thickness, visual objects, visual rig, surface zebra, physical components, and precise or dense section slices.
|
|
178
169
|
- `forgecad inspect section` runs an agent-native one-off section probe with exact ray ruler measurements and a replay recipe.
|
|
179
170
|
- `forgecad inspect mechanical-integrity` checks assembly-level verification intent and optional collision evidence.
|
|
180
171
|
- `forgecad run -p "Name=Value"` validates important parameter values without editing source.
|
|
@@ -198,7 +189,7 @@ The CLI is not just a launcher. It gives the agent a measurable feedback loop.
|
|
|
198
189
|
| Produce visual evidence | `forgecad render 3d model.forge.js --camera iso` | PNG viewport renders from deterministic camera angles. |
|
|
199
190
|
| Measure a targeted section | `forgecad inspect section model.forge.js --plane yz --ray bore:-20,0:20,0` | A unique probe directory with `result.json`, `section.svg`, `section.png`, exact solid/gap intervals along each ray, and a `replaySpec` for candidate comparisons. Use `--offset` only when the cut should move away from the zero plane. |
|
|
200
191
|
| Replay a targeted section | `forgecad inspect replay outputs/inspect/<probe>/result.json --source candidate.forge.js` | Reruns the same plane and ray rulers against another source and reports measurement deltas. |
|
|
201
|
-
| Inspect targeted geometry evidence | `forgecad inspect fit interference model.forge.js --camera iso` | A bundle with manifest plus the requested evidence PNGs. Visual inspection evidence uses the light technical `inspection` style by default. Use `inspect visual cutaway`, `inspect visual objects`, `inspect manufacture thickness`, `inspect sections at|stack|sample`, `inspect visual depth`, `inspect visual normals`, `inspect physical components`, or `inspect physical gaps` for other questions. |
|
|
192
|
+
| Inspect targeted geometry evidence | `forgecad inspect fit interference model.forge.js --camera iso` | A bundle with manifest plus the requested evidence PNGs. Visual inspection evidence uses the light technical `inspection` style by default. Use `inspect visual cutaway`, `inspect visual objects`, `inspect visual rig`, `inspect manufacture thickness`, `inspect sections at|stack|sample`, `inspect visual depth`, `inspect visual normals`, `inspect physical components`, or `inspect physical gaps` for other questions. |
|
|
202
193
|
| Export manufacturing files | `forgecad export stl model.forge.js` and `forgecad export 3mf model.forge.js` | Mesh exports for 3D printing. |
|
|
203
194
|
| Export exact or advanced outputs | `forgecad export step`, `forgecad export brep`, `forgecad export report`, `forgecad export cutting-layout` | Production outputs for CAD interchange, reports, and sheet workflows. |
|
|
204
195
|
| Sync hosted projects | `forgecad project pull`, `forgecad project push`, `forgecad project publish` | Local-agent workflow connected to forgecad.io projects and shares. |
|
|
@@ -223,7 +214,7 @@ For the full command reference, see [ForgeCAD CLI](../CLI.md).
|
|
|
223
214
|
| `forgecad-visual-spec` | Producing builder-honest image prompts from a concrete model, HLD, LLD, or build brief. |
|
|
224
215
|
| `forgecad-project` | Managing forgecad.io projects from the CLI: init, clone, pull, push, file commands, members, publish, and shares. |
|
|
225
216
|
|
|
226
|
-
The source prompts live in the repository under `
|
|
217
|
+
The source prompts for CLI-shipped companion skills live in the repository under `agent-skill-library/`. Public export is controlled by `forgecad-public: true` in each skill's `SKILL.md` frontmatter. Repo-local operational skills live under `.agents/skills/` and are not shipped through the CLI. To list the current public set from a source checkout:
|
|
227
218
|
|
|
228
219
|
```bash
|
|
229
220
|
npm run sync:public-skills -- --list
|
package/dist/docs-raw/CLI.md
CHANGED
|
@@ -162,11 +162,12 @@ Inspect a model by asking for one explicit kind of evidence.
|
|
|
162
162
|
|
|
163
163
|
`forgecad inspect` is the evidence-first inspection surface. Pick the job you want to verify, then choose the view like you would with `render 3d`.
|
|
164
164
|
|
|
165
|
+
- `inspect sketch` — returned sketch/profile regions, selector dry-runs, and extrusion compatibility
|
|
165
166
|
- `inspect history` — final-object feature recipes and feedback anchors
|
|
166
167
|
- `inspect design-trace` — raw construction DAG, source spans, and cache diagnostics
|
|
167
168
|
- `inspect section` — agent-native one-off section probe with optional ray rulers and replay JSON
|
|
168
169
|
- `inspect replay` — rerun a saved section probe on the same or another source
|
|
169
|
-
- `inspect visual image|cutaway|depth|normals|objects` — visual context, clipped 3D cutaways, depth, normals, and identity evidence
|
|
170
|
+
- `inspect visual image|cutaway|depth|normals|rig|objects` — visual context, clipped 3D cutaways, depth, normals, rig skeletons, and identity evidence
|
|
170
171
|
- `inspect surface zebra|roughness` — surface continuity and roughness evidence
|
|
171
172
|
- `inspect physical components|floating|gaps` — physical component graph evidence
|
|
172
173
|
- `inspect fit interference` — positive-volume overlap evidence
|
|
@@ -189,8 +190,27 @@ forgecad inspect sections stack main.forge.js --plane yz --every 1
|
|
|
189
190
|
forgecad inspect compare overlay candidate.forge.js --with reference.3mf
|
|
190
191
|
```
|
|
191
192
|
|
|
193
|
+
### `forgecad inspect sketch`
|
|
194
|
+
|
|
195
|
+
Inspect returned sketches and profile regions used by returned shapes.
|
|
196
|
+
|
|
197
|
+
Runs a model and reports inspectable 2D sketch/profile regions without requiring model code to register inspection hooks. The command inspects returned Sketch objects and profile-bearing shape compile plans such as extrude, cut, and revolve. Use `--seed x,y` to dry-run which region a point selector would consume, and `--operation extrude` to check extrusion compatibility.
|
|
198
|
+
|
|
199
|
+
```bash
|
|
200
|
+
forgecad inspect sketch examples/api/sketch-regions.forge.js
|
|
201
|
+
forgecad inspect sketch model.forge.js --object "Profile" --seed 45,15
|
|
202
|
+
forgecad inspect sketch model.forge.js --json --object "Body" --seed 45,15 --operation extrude
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
`inspect sketch` is external inspection: it runs the script, then reads returned scene objects and shape compile plans. Model code should not call an inspection API. It reports selectable 2D `regions` from returned `Sketch` / `ConstraintSketch` objects and from profile-bearing returned shapes (`extrude.profile`, `cut.profile`, `revolve.profile`).
|
|
206
|
+
|
|
207
|
+
JSON contract: `targets[]` are inspectable sketches/profile uses; `regions[]` are filled selectable areas sorted largest-first with run-local ids like `R0`; `holes[]` are excluded interiors; `selection` is present only with `--seed`; `profileTree` is compile-plan provenance, not JavaScript variable names. Stable selection v1 is `--seed x,y`, not region id.
|
|
208
|
+
|
|
209
|
+
Seed failures are explicit and exit nonzero when no target matches: outside every region, on a boundary, inside a hole, ambiguous, no regions, or incompatible operation. `--operation extrude` only checks whether the selected filled region can be consumed by extrusion; open path/rail selection is intentionally unsupported in v1.
|
|
210
|
+
|
|
192
211
|
| Command | Description |
|
|
193
212
|
|---------|-------------|
|
|
213
|
+
| `inspect sketch` | Inspect returned sketches and profile regions used by returned shapes. |
|
|
194
214
|
| `inspect visual image` | Capture standard shaded viewport evidence. |
|
|
195
215
|
| `inspect visual objects` | Capture object identity evidence. |
|
|
196
216
|
| `inspect section` | Run one exact section probe with optional ray rulers. |
|
|
@@ -229,7 +249,7 @@ forgecad render hq examples/products/cup.forge.js --preset dramatic
|
|
|
229
249
|
|
|
230
250
|
Render a Forge scene to PNG using the real viewport renderer.
|
|
231
251
|
|
|
232
|
-
Launches a headless Chrome instance, renders the scene with the same WebGL viewport as the editor, and saves a PNG. The output path defaults to `<script-name>.png` next to the input file.
|
|
252
|
+
Launches a headless Chrome instance, renders the scene with the same WebGL viewport as the editor, and saves a PNG. The output path defaults to `<script-name>.png` next to the input file. Each render uses a private renderer server by default, so parallel renders do not compete for the same Vite port.
|
|
233
253
|
|
|
234
254
|
The input can be a `.forge.js` script or a direct `.stl`, `.obj`, `.3mf`, `.step`, or `.stp` asset. Direct STEP/STP rendering auto-selects OCCT unless you pass `--backend`.
|
|
235
255
|
|
|
@@ -299,9 +319,9 @@ forgecad render hq examples/products/cup.forge.js --transparent --preset glass
|
|
|
299
319
|
|
|
300
320
|
### `forgecad capture gif|mp4` **\[Pro\]**
|
|
301
321
|
|
|
302
|
-
Animated orbit or joint playback.
|
|
322
|
+
Animated orbit, section sweep, or named joint playback.
|
|
303
323
|
|
|
304
|
-
Renders an animated sequence by either orbiting the camera around the model or playing back a
|
|
324
|
+
Renders an animated sequence by either orbiting the camera around the model or playing back a named joint animation. Use `--capture orbit` (default) for a turntable rotation, `--capture animation --animation <name>` to play a named joint clip, or `--capture section-sweep` to move a clipping plane through the model. Supports `--cut-plane` to animate with a static cross-section visible. Use `--view`, `--camera`, `--camera-json`, or `--scene <file>` to choose the orbit base camera or the fixed camera for animations and section sweeps.
|
|
305
325
|
|
|
306
326
|
```bash
|
|
307
327
|
forgecad capture gif examples/products/cup.forge.js
|
|
@@ -311,7 +331,7 @@ forgecad capture gif model.forge.js out/front.gif --camera front
|
|
|
311
331
|
forgecad capture gif model.forge.js out/hero.gif --view hero
|
|
312
332
|
forgecad capture gif examples/3d-printer.forge.js out/sweep.gif --capture section-sweep --sweep-plane YZ
|
|
313
333
|
forgecad capture mp4 examples/products/cup.forge.js
|
|
314
|
-
forgecad capture mp4 examples/api/
|
|
334
|
+
forgecad capture mp4 examples/api/assembly-kinematics-four-bar.forge.js out/four-bar.mp4 --view iso
|
|
315
335
|
forgecad capture mp4 model.forge.js out/raw.mp4 --param "Output=raw-sdf"
|
|
316
336
|
forgecad capture mp4 model.forge.js out/front.mp4 --camera front
|
|
317
337
|
forgecad capture mp4 model.forge.js out/hero.mp4 --view hero
|
|
@@ -356,9 +376,9 @@ forgecad render section examples/furniture/01-table.forge.js out/bold.svg --edge
|
|
|
356
376
|
| `--background <color>` | Canvas background override |
|
|
357
377
|
| `--render-mode <solid\|wireframe>` | Shaded solid (default) or wireframe only |
|
|
358
378
|
| `--edges <off\|thin\|bold>` | Edge overlay preset in solid mode (default: off) |
|
|
359
|
-
| `--render-style <classic\|studio\|fast\|glass\|inspection\|
|
|
379
|
+
| `--render-style <classic\|studio\|fast\|glass\|inspection\|contour\|scan>` | Visual render style (render default: classic; inspect default: inspection) |
|
|
360
380
|
| `--scan-granularity <12-144>` | Scan cells across the scene longest axis |
|
|
361
|
-
| `--port <n>` |
|
|
381
|
+
| `--port <n>` | Renderer server port |
|
|
362
382
|
| `--fresh-server` | Start a fresh renderer instead of reusing an existing one |
|
|
363
383
|
| `--chrome-path <path>` | Chrome or Chromium executable path |
|
|
364
384
|
| `--output <path>` | Output file path |
|
|
@@ -379,7 +399,7 @@ forgecad render section examples/furniture/01-table.forge.js out/bold.svg --edge
|
|
|
379
399
|
| `--pitch <deg>` | Camera pitch angle in degrees |
|
|
380
400
|
| `--format <gif\|mp4>` | Output format |
|
|
381
401
|
| `--capture <orbit\|animation\|section-sweep>` | Capture preset |
|
|
382
|
-
| `--animation <name>` | Named
|
|
402
|
+
| `--animation <name>` | Named joint animation clip |
|
|
383
403
|
| `--animation-loops <n>` | Repeat the selected animation clip |
|
|
384
404
|
| `--cut-plane <name>` | Enable a named cut plane |
|
|
385
405
|
| `--sweep-plane <XY\|XZ\|YZ>` | Moving plane for section-sweep |
|
|
@@ -449,8 +469,8 @@ forgecad export sdf rover.forge.js --output out/forge_scout
|
|
|
449
469
|
| Option | Description |
|
|
450
470
|
|--------|-------------|
|
|
451
471
|
| `--output <path>` | Output STEP path |
|
|
472
|
+
| `--backend <occt\|truck>` | Exact BREP exporter: occt (default) or truck (native analytic kernel) |
|
|
452
473
|
| `--quality <default\|live\|high>` | Forge quality preset |
|
|
453
|
-
| `--backend <manifold\|occt\|truck>` | Geometry backend (default: manifold) |
|
|
454
474
|
| `-o <path>` | Shorthand for --output |
|
|
455
475
|
| `--dim-angle-tol <deg>` | Dimension routing tolerance in degrees |
|
|
456
476
|
| `--format <pdf\|dxf>` | Output format |
|
|
@@ -484,7 +504,7 @@ cd start-here
|
|
|
484
504
|
forgecad studio .
|
|
485
505
|
```
|
|
486
506
|
|
|
487
|
-
`forgecad login` asks how you want to sign in, then prompts for either email/password or an API token. If your account was created through GitHub or Google, create an API token in Settings > API Tokens, run `forgecad login`, and choose API token. Use `FORGECAD_TOKEN=fc_pat_...` only for CI/CD and one-off automation.
|
|
507
|
+
`forgecad login` asks how you want to sign in, then prompts for either email/password or an API token. If your account was created through GitHub or Google, create an API token in Settings > API Tokens, run `forgecad login`, and choose API token. Use `FORGECAD_TOKEN=fc_pat_...` only for CI/CD and one-off automation.
|
|
488
508
|
|
|
489
509
|
`forgecad project init` creates the remote project, writes `forgecad.json`, pushes any existing local source files, and records server file IDs. `forgecad project push` syncs an already initialized project; it does not create a remote project from an arbitrary folder.
|
|
490
510
|
|
|
@@ -35,18 +35,27 @@ return rack.withConnectors({
|
|
|
35
35
|
|
|
36
36
|
### Rule 2: Connectors Are the Interface
|
|
37
37
|
|
|
38
|
-
Every part that participates in an assembly declares connectors. A connector says: "here's where I connect, and
|
|
38
|
+
Every part that participates in an assembly declares connectors. A connector says: "here's where I connect, what direction I face, and what roll I consider upright." It's the part's public interface — the only thing the assembly needs to know.
|
|
39
39
|
|
|
40
40
|
```js
|
|
41
41
|
return mount.withConnectors({
|
|
42
42
|
flange: connector("bolt-face", {
|
|
43
43
|
origin: [0, 0, 0], // where the mating surface is
|
|
44
44
|
axis: [0, 0, 1], // direction it faces (outward from part)
|
|
45
|
+
up: [1, 0, 0], // roll reference when orientation matters
|
|
45
46
|
}),
|
|
46
47
|
});
|
|
47
48
|
```
|
|
48
49
|
|
|
49
|
-
|
|
50
|
+
A connector is a small local frame:
|
|
51
|
+
|
|
52
|
+
- `origin` is the pivot, contact point, socket center, or mating-face point.
|
|
53
|
+
- `axis` is the primary direction: face normal, hinge line, or slide direction.
|
|
54
|
+
- `up` is the secondary direction that fixes roll around `axis`.
|
|
55
|
+
|
|
56
|
+
`up` is not world up. It is the connector's local roll reference and must not be parallel to `axis`. If `up` is omitted, ForgeCAD picks a deterministic perpendicular vector. That is fine when roll does not matter, but hinges, wheels, levers, and keyed parts should author `up` explicitly.
|
|
57
|
+
|
|
58
|
+
Connectors meet **face-to-face**. Both axes point outward from their respective parts. The system brings them together from opposite sides, then uses `up` to pin the rest orientation — like plugging in a keyed connector instead of a round peg.
|
|
50
59
|
|
|
51
60
|
### Rule 3: The Assembly Is Pure Composition
|
|
52
61
|
|
|
@@ -117,22 +126,29 @@ Change the servo model → the mount rebuilds with new cavity dimensions → its
|
|
|
117
126
|
|
|
118
127
|
## The Connector Convention
|
|
119
128
|
|
|
120
|
-
Connectors follow one convention: **face-to-face**.
|
|
129
|
+
Connectors follow one convention: **face-to-face connector frames**.
|
|
121
130
|
|
|
122
|
-
Each connector's axis points **outward** from its part — the direction the connection faces. When two connectors mate, the system negates one axis so they approach from opposite sides.
|
|
131
|
+
Each connector's axis points **outward** from its part — the direction the connection faces. When two connectors mate, the system makes their origins coincide and, for fixed/revolute joints, negates one axis so they approach from opposite sides. The `up` vectors define the roll reference that makes the rest pose deterministic.
|
|
123
132
|
|
|
124
133
|
- **Fixed joints** (bolt flange): both faces point outward, system brings them together
|
|
125
|
-
- **Revolute joints** (hinge): both parts point outward along the hinge line, system opposes them
|
|
126
|
-
- **Prismatic joints** (slider): both connectors point along the slide direction (co-directional exception — the slide axis IS the shared direction)
|
|
134
|
+
- **Revolute joints** (hinge): both parts point outward along the hinge line, system opposes them, and `up` pins zero angle
|
|
135
|
+
- **Prismatic joints** (slider): both connectors point along the slide direction (co-directional exception — the slide axis IS the shared direction), while `up` still pins roll around the rail
|
|
136
|
+
|
|
137
|
+
Revolute joint values are still signed by the physical hinge axis. If a bilateral
|
|
138
|
+
mechanism mirrors a hinge axis, the mirrored pose uses the negated physical value
|
|
139
|
+
(`Right: +theta`, `Left: -theta`), and physical limits mirror as
|
|
140
|
+
`[min, max] -> [-max, -min]`. Prismatic joints do not have this angle-handedness
|
|
141
|
+
flip. Use a side-neutral link graph or explicit state mapping when equal semantic
|
|
142
|
+
pose values should drive both sides.
|
|
127
143
|
|
|
128
144
|
```js
|
|
129
145
|
// Base bottom face points down, mount flange points up → meet in the middle
|
|
130
|
-
base.withConnectors({ mount_face: connector("bolt-face", { origin: [0,0,0], axis: [0,0,-1] }) });
|
|
131
|
-
mount.withConnectors({ flange: connector("bolt-face", { origin: [0,0,0], axis: [0,0,1] }) });
|
|
146
|
+
base.withConnectors({ mount_face: connector("bolt-face", { origin: [0,0,0], axis: [0,0,-1], up: [1,0,0] }) });
|
|
147
|
+
mount.withConnectors({ flange: connector("bolt-face", { origin: [0,0,0], axis: [0,0,1], up: [1,0,0] }) });
|
|
132
148
|
|
|
133
|
-
// Hinge:
|
|
134
|
-
frame.withConnectors({ hinge: connector("hinge", { origin: [0,0,40], axis: [0,0,1] }) });
|
|
135
|
-
door.withConnectors({ hinge: connector("hinge", { origin: [0,0,40], axis: [0,0,-1] }) });
|
|
149
|
+
// Hinge: axes oppose along the pin, up pins the closed/rest roll
|
|
150
|
+
frame.withConnectors({ hinge: connector("hinge", { origin: [0,0,40], axis: [0,0,1], up: [1,0,0] }) });
|
|
151
|
+
door.withConnectors({ hinge: connector("hinge", { origin: [0,0,40], axis: [0,0,-1], up: [1,0,0] }) });
|
|
136
152
|
```
|
|
137
153
|
|
|
138
154
|
## One File vs. Many Files
|