Skip to content
Back to search

partmode

Open-source, local-first 3D parametric CAD that runs in the browser for people and permissioned typed agents, powered by OpenCascade WASM.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/bomwiki--partmode/badge.svg)](/listings/bomwiki--partmode)

HTML

<a href="/listings/bomwiki--partmode"><img src="/api/listings/bomwiki--partmode/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 238 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <p align="center">
  2. <img src="src/static/partmode-mark.svg" alt="" width="92">
  3. </p>
  4. <h1 align="center">PartMode</h1>
  5. <p align="center">
  6. <strong>Open-source, local-first parametric CAD for people and permissioned typed agents.</strong>
  7. </p>
  8. <p align="center">
  9. <a href="https://partmode.com/"><strong>Open PartMode</strong></a>
  10. ·
  11. <a href="https://partmode.com/help">Read the help</a>
  12. ·
  13. <a href="docs/architecture.md">Explore the architecture</a>
  14. ·
  15. <a href="CONTRIBUTING.md">Contribute</a>
  16. </p>
  17. PartMode is browser-based mechanical CAD built on OpenCascade WebAssembly,
  18. replicad, and three.js. It combines constrained sketches, editable feature
  19. history, exact B-rep evaluation, assemblies, drawings, and standard exchange
  20. formats in one application that runs without a desktop CAD installation.
  21. It is built around a simple idea: human and agent changes should use the same
  22. canonical document model and exact kernel instead of parallel, opaque
  23. automation state. In a browser-approved session they can revise the same open
  24. project; the separate headless path uses its own account-owned document.
  25. | Local by default | Exact geometry | Shared model + kernel |
  26. | --- | --- | --- |
  27. | Model anonymously in the browser. Optional hosted agent connectivity and headless document storage are separate, explicit choices. | OpenCascade evaluates solid B-rep geometry. The shaded three.js scene is a view of the result, not the source of truth. | People use the CAD interface. Agents use typed, permissioned operations against the same schema and kernel; browser-approved agents can edit the open project. |
  28. PartMode is free to use, inspect, modify, and self-host under the
  29. [GNU AGPL v3 license](LICENSE).
  30. ## See PartMode in 18 seconds
  31. [![Watch the 18-second PartMode contributor demo](docs/media/partmode-social-preview.png)](docs/media/partmode-contributor-demo.mp4)
  32. Open an editable template, make a human parameter edit, approve a typed agent
  33. change, rebuild the exact geometry, and export STEP.
  34. The demo was captured locally from public source snapshot `8db0b804` using the
  35. production typed-agent protocol. The complete steps and evidence are in the
  36. [capture notes](docs/media/README.md).
  37. ## What you can build
  38. | Area | Included capabilities |
  39. | --- | --- |
  40. | Parametric parts | Constrained sketches, dimensions and expressions, editable feature history, multiple solid bodies, direct edits, configurations, patterns, holes, threads, sheet-metal, and structural tools |
  41. | Assemblies | Reusable part definitions, occurrences, mates, direct in-context component editing, exploded views, sections, dependency inspection, and assembly mass properties |
  42. | Drawings | Exact OpenCascade hidden-line views; SVG and PDF sheets can carry document-owned dimensions, tolerances, notes, symbols, and tables, while DXF exports a restricted R12 orthographic or sketch geometry subset |
  43. | Interchange | Editable PartMode project bundles, STEP import and export, plus STL, AMF, and 3MF mesh exports |
  44. | Inspection | Measurements, geometry health, volume, surface area, material-driven mass properties, centers of mass, inertia tensors, and persistent topology evidence |
  45. | Agent workflows | Hosted MCP tools for capabilities, inspection, queries, detached previews, revision-safe commits, browser artifacts, and opt-in server-headless STEP workflows |
  46. Templates are editable schema-5 starting projects, not decorative meshes.
  47. Exact capability coverage varies by template, and a failed rebuild is reported
  48. instead of being treated as valid geometry.
  49. ## One document model, two authority paths
  50. ```mermaid
  51. flowchart LR
  52. H["Human browser UI"] --> L["Browser-local schema-5 document"]
  53. A["Typed agent client"] --> G{"Authority chosen by account owner"}
  54. G --> B["Browser-approved local session"]
  55. G --> X["Headless-granted session"]
  56. B --> L
  57. X --> S["Account-owned schema-5 document"]
  58. L --> K["Shared OpenCascade WASM exact kernel"]
  59. S --> K
  60. K --> E["Exact B-rep evidence"]
  61. E --> O["Browser drawings and supported artifacts"]
  62. E --> T["Headless STEP export"]
  63. ```
  64. ### Browser-approved local projects
  65. - Anonymous browser CAD needs no account. Projects, geometry, and recovery
  66. history remain in browser storage.
  67. - Hosted browser-agent access requires an account, a revocable agent key, a
  68. signed-in PartMode tab, and visible approval for the project-scoped session.
  69. A key authenticates the agent but does not grant CAD authority by itself.
  70. - Approved commands and results cross the hosted relay over HTTPS and remain
  71. only in bounded process memory. There is no offline queue, the relay is not
  72. end-to-end encrypted, and the browser project itself is not stored there.
  73. - The agent inspects current state, creates a detached preview, and commits only
  74. against the matching document revision. The person can reject, pause,
  75. disconnect, or revoke access.
  76. ### Server-headless durable projects
  77. - An edit key can be created with an explicit, immutable headless grant for
  78. unattended CAD. This is a separate storage and authority choice, not an
  79. automatic extension of browser access.
  80. - Live headless sessions are key-bound, expire within one hour, and do not
  81. survive a service restart. Only committed headless documents are durable.
  82. - Committed records survive session expiry, key revocation, restarts, and
  83. deployments, and remain until account deletion; there is no individual
  84. project-delete control yet. Headless execution has no visible Studio and a
  85. narrower artifact surface; STEP is the current dedicated export path.
  86. Read the [agent workflow](docs/help/agents.md) for the complete permission,
  87. storage, session, and tool boundaries. Live `cad_capabilities` output remains
  88. authoritative for the exact operations and schemas supported by a running
  89. release.
  90. ## Run locally
  91. PartMode requires Node.js 22.13 or newer.
  92. ```sh
  93. git clone https://github.com/BOMWiki/partmode.git
  94. cd partmode
  95. npm ci
  96. npm run build
  97. npm start
  98. ```
  99. Open `http://127.0.0.1:4401`. Browser-local CAD does not require an account or
  100. an external service.
  101. To run the focused contributor gate:
  102. ```sh
  103. npm run ci:gate
  104. ```
  105. The gate type-checks and builds the release, verifies static and runtime
  106. manifests, and exercises the local HTTP, account, identity, MCP, cloud, and
  107. entrypoint contracts. CAD, kernel, assembly, export, and visible UI changes
  108. also require the affected `smoke:*` checks. The broader blocking release gate
  109. is available through `npm run release:gate`; the professional and nightly
  110. matrices are separate.
  111. ## Connect an MCP agent
  112. Create a revocable key from [Agent access](https://partmode.com/account), then
  113. store it in the secret environment used to launch your MCP client. Do not paste
  114. the key into a prompt, URL, command argument, or repository file.
  115. For Codex:
  116. ```sh
  117. codex mcp add partmode \
  118. --url https://partmode.com/mcp \
  119. --bearer-token-env-var PARTMODE_AGENT_KEY
  120. ```
  121. Start a new session, read the PartMode Help resources, and call
  122. `cad_capabilities` before constructing a transaction. Use a browser-approved
  123. session when a person should see and approve the work, or deliberately create a
  124. headless-granted edit key for an unattended server project.
  125. ## Architecture at a glance
  126. The browser and agent paths share the canonical document model and exact
  127. kernel-worker boundary:
  128. - `src/page.html` and the focused `src/static/studio-*` modules implement the
  129. visible product, documents, modeling, assemblies, drawings, storage, and
  130. interaction behavior.
  131. - `src/static/studio-agent-service.js` validates typed operations, creates
  132. detached previews, enforces revisions, and commits accepted changes.
  133. - `src/static/studio-kernel.worker.js` isolates exact rebuild, validation,
  134. import, export, drawing, and inspection work from the UI thread.
  135. - `src/mcp.ts`, `src/relay-hub.ts`, and `src/headless-sessions.ts` implement the
  136. hosted MCP, browser relay, and server-headless boundaries.
  137. See the [architecture guide](docs/architecture.md) for the component map,
  138. verification map, and design rules.
  139. ## Contribute
  140. Start with a [good first issue](https://github.com/BOMWiki/partmode/labels/good%20first%20issue)
  141. or a [help wanted issue](https://github.com/BOMWiki/partmode/labels/help%20wanted).
  142. Comment before starting so scope and ownership are clear.
  143. For a behavior change:
  144. 1. Stay within the issue's accepted boundary.
  145. 2. Add or update the narrowest relevant regression.
  146. 3. Run `npm run ci:gate`.
  147. 4. Run every affected `smoke:*` command named by the issue or change area.
  148. | Area | Start here | Typical focused checks |
  149. | --- | --- | --- |
  150. | Browser UI and recovery | `src/page.html`, `src/static/studio.js`, `src/static/studio-storage.js` | `smoke:browser`, `smoke:usability-ui` |
  151. | Documents and features | `src/static/studio-project-v5.js`, `src/static/studio-v5-runtime-document.js` | the affected feature `smoke:*` test |
  152. | Exact geometry and topology | `src/static/studio-kernel.worker.js`, `src/static/studio-brep-evidence.js`, `src/static/studio-topo-naming.js` | `smoke:brep-evidence`, `smoke:topology-hash`, `smoke:cad-regression` |
  153. | Assemblies | `src/static/studio-v5-assembly.js`, `src/static/studio-assembly-*` | `smoke:assembly-runtime` plus the affected assembly smoke |
  154. | Typed agents and headless | `src/static/studio-agent-service.js`, `src/mcp.ts`, `src/relay-hub.ts`, `src/headless-sessions.ts` | `smoke:cloud`, `smoke:mcp`, `smoke:headless-mcp` |
  155. | Drawings and exchange | `src/static/studio-drawing-*`, kernel import and export handlers | the affected `smoke:drawing-*`, `smoke:step-determinism` |
  156. For CAD changes, screenshots and mesh counts are supporting evidence only.
  157. Report the settled document result and the exact kernel, B-rep, topology, or
  158. export evidence required by the issue. Visible behavior changes also need
  159. browser evidence.
  160. [Contributing guide](CONTRIBUTING.md) · [Architecture](docs/architecture.md) ·
  161. [Contribution roadmap](ROADMAP.md) · [Public-source changelog](CHANGELOG.md)
  162. ## Limits and engineering responsibility
  163. PartMode is engineering software, not a certification authority. Validate
  164. dimensions, tolerances, materials, standards content, and released
  165. manufacturing data for your application.
  166. PartMode does not currently provide engineering simulation, certified
  167. analysis, automated design approval, CAM, native DWG authoring, or a general
  168. standards-certified GD&T/PMI workbench. Imported STEP does not reconstruct a
  169. vendor's native feature history, mates, or PMI. Read
  170. [limits, evidence, and safety](docs/help/limits-and-safety.md) for the current
  171. product boundary.
  172. ## Repository scope
  173. This repository contains the standalone PartMode product source, public
  174. technical documentation, fixtures, and tests. Production credentials, private
  175. operations, deployment configuration, internal handovers, and release records
  176. are intentionally outside this repository.
  177. The BOMWiki organization is the administrative home of this repository;
  178. PartMode does not depend on BOMWiki applications, services, databases, ports,
  179. or deployment infrastructure.
  180. See [SECURITY.md](SECURITY.md) for vulnerability reports. Third-party
  181. components and their licenses are listed in
  182. [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
  183. ## License
  184. PartMode is licensed under the
  185. [GNU Affero General Public License v3.0 only](LICENSE). Copyright © 2026 Sphinx.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.