cyclecad 3.9.11 → 3.9.12

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.
Files changed (3) hide show
  1. package/README.md +61 -132
  2. package/package.json +1 -1
  3. package/~$cycleCAD-Architecture-v2.pptx +0 -0
package/README.md CHANGED
@@ -1,186 +1,120 @@
1
- <div align="center">
1
+ # ⚙ cycleCAD
2
2
 
3
- <img src="https://raw.githubusercontent.com/vvlars-cmd/cyclecad/main/screenshot.png" alt="cycleCAD" width="720">
3
+ **Open-source browser CAD with a B-Rep kernel.**
4
+ Real solid modeling. Real fillets. Real booleans. No install. No login. Free forever.
4
5
 
5
- <h1>cycleCAD</h1>
6
-
7
- <p><strong>Open-source browser CAD with a B-Rep kernel.</strong><br>
8
- Real solid modeling. Real fillets. Real booleans. No install. No login. Free forever.</p>
9
-
10
- <a href="https://www.npmjs.com/package/cyclecad"><img src="https://img.shields.io/npm/v/cyclecad?style=flat-square&logo=npm&color=CB3837" alt="npm"></a>
11
- <a href="https://www.npmjs.com/package/cyclecad"><img src="https://img.shields.io/npm/dw/cyclecad?style=flat-square&color=CB3837" alt="downloads"></a>
12
- <a href="https://github.com/vvlars-cmd/cyclecad/stargazers"><img src="https://img.shields.io/github/stars/vvlars-cmd/cyclecad?style=flat-square&logo=github" alt="stars"></a>
13
- <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="MIT"></a>
14
-
15
- <br><br>
16
-
17
- <a href="https://cyclecad.com/app/"><strong>Open App</strong></a> · <a href="https://github.com/vvlars-cmd/cyclecad">Source</a> · <a href="https://cyclecad.com/docs">Docs</a> · <a href="https://www.npmjs.com/package/cyclecad">npm</a>
18
-
19
- </div>
6
+ [Open App](https://cyclecad.com/app) · [Source](https://github.com/vvlars-cmd/cyclecad) · [Docs](https://cyclecad.com/app/docs/) · [npm](https://www.npmjs.com/package/cyclecad)
20
7
 
21
8
  ---
22
9
 
23
10
  ## What is this
24
11
 
25
- cycleCAD is a parametric 3D CAD modeler that runs entirely in the browser. It uses OpenCascade.js (WASM) as a real B-Rep solid modeling kernel — the same geometry engine behind FreeCAD and KiCad. You get actual solid geometry, not mesh approximations.
12
+ cycleCAD is a parametric 3D CAD modeler that runs entirely in the browser. It uses OpenCascade.js (WASM) as a real B-Rep solid modeling kernel — the same geometry engine behind FreeCAD and KiCad.
26
13
 
27
14
  Type `motor mount plate with 4 bolt holes` into the AI copilot and get a real 3D solid in seconds.
28
15
 
29
- ```
30
- > create a motor mount plate 100mm wide, 80mm tall
31
- ✓ solid rectangular prism
32
-
33
- > add 4 bolt holes in corners, 10mm diameter
34
- ✓ holes cut through plate
35
-
36
- > fillet all edges 2mm
37
- ✓ edges rounded — ready to manufacture
38
- ```
39
-
40
- ---
41
-
42
16
  ## How it compares
43
17
 
44
18
  | | cycleCAD | OnShape | Fusion 360 | FreeCAD |
45
- |:--|:--|:--|:--|:--|
46
- | Runs in browser | Yes | Cloud | Desktop | Desktop |
47
- | Cost | Free | $1,500/yr | $545/yr | Free |
48
- | Text-to-CAD | Yes | No | No | No |
19
+ |---|---|---|---|---|
20
+ | Runs in browser | ✅ Yes | Cloud | Desktop | Desktop |
21
+ | Cost | **Free** | $1,500/yr | $545/yr | Free |
22
+ | Text-to-CAD | ✅ Yes | No | No | No |
49
23
  | B-Rep kernel | OpenCascade.js | Parasolid | Parasolid | OpenCascade |
50
24
  | Multiplayer | WebRTC P2P | Paid | No | No |
51
25
  | Inventor files | .ipt/.iam native | No | Yes | No |
52
26
  | Open source | MIT | No | No | LGPL |
53
- | Mobile viewer | Yes | No | No | No |
54
-
55
- ---
27
+ | Mobile viewer | ✅ Yes | No | No | No |
56
28
 
57
29
  ## Get started
58
30
 
59
- **Browser** — open [cyclecad.com/app](https://cyclecad.com/app/) and start designing.
31
+ **Browser** — open [cyclecad.com/app](https://cyclecad.com/app) and start designing.
60
32
 
61
33
  **npm:**
62
-
63
34
  ```bash
64
35
  npm install -g cyclecad
65
36
  cyclecad
66
37
  ```
67
38
 
68
39
  **Clone:**
69
-
70
40
  ```bash
71
41
  git clone https://github.com/vvlars-cmd/cyclecad.git
72
42
  cd cyclecad && npm run dev
73
43
  ```
74
44
 
75
- ---
76
-
77
- ## Architecture
78
-
79
- ```
80
- ┌──────────────────────────────────────────────────────┐
81
- │ cycleCAD — Browser Runtime │
82
- │ │
83
- │ ┌─────────────────────────────────────────────────┐ │
84
- │ │ UI Layer — Toolbar · Tree · Properties · Chat │ │
85
- │ └─────────────────────┬───────────────────────────┘ │
86
- │ │ │
87
- │ ┌─────────────────────▼───────────────────────────┐ │
88
- │ │ LEGO Microkernel │ │
89
- │ │ Module Registry · Event Bus · Command System │ │
90
- │ │ Memory Manager · Shared State · Hot-Swap │ │
91
- │ └──┬──────────┬──────────┬──────────┬─────────────┘ │
92
- │ │ │ │ │ │
93
- │ ┌──▼───┐ ┌──▼───┐ ┌──▼───┐ ┌──▼────────────┐ │
94
- │ │Sketch│ │ Ops │ │B-Rep │ │ Services │ │
95
- │ │Engine│ │extr. │ │Kernel│ │ AI · Multi · │ │
96
- │ │2D │→ │rev. │→ │OCCT │ │ Marketplace │ │
97
- │ │const.│ │bool. │ │WASM │ │ Simulation │ │
98
- │ └──────┘ └──────┘ └──────┘ └───────────────┘ │
99
- │ │
100
- │ ┌──────────────────────────────────────────────────┐│
101
- │ │ I/O — STEP · Inventor · STL · OBJ · glTF · DXF ││
102
- │ └──────────────────────────────────────────────────┘│
103
- └──────────────────────────────────────────────────────┘
104
- ```
105
-
106
- The kernel is ~300 lines. Everything else is a LEGO module that loads on demand. The B-Rep kernel (50MB WASM) only downloads when you need solid geometry. Modules can be hot-swapped at runtime.
107
-
108
- ---
109
-
110
- ## Features
111
-
112
- **Modeling** — Parametric sketcher with 17 tools (line, rect, circle, arc, ellipse, spline, polygon, slot, trim, extend, offset, mirror, fillet, chamfer, construction, dimension, pattern). 12 constraint types. Extrude, revolve, sweep, loft, shell, fillet, chamfer, boolean, pattern, mirror, draft, hole, thread, rib.
113
-
114
- **B-Rep Kernel** — Real solid geometry via OpenCascade.js WASM. True edge fillets and chamfers (not mesh approximations). Real boolean operations. STEP import/export. Mass properties with center of gravity. Edge and face selection.
115
-
116
- **Drawing** — 2D engineering drawing workspace with orthographic views, section views, detail views. Linear, angular, radial, diameter dimensions. GD&T symbols, surface finish, weld symbols, balloons, title blocks, BOM tables. Export to PDF, DXF, SVG.
117
-
118
- **Simulation** — Static stress analysis (FEA), thermal analysis, modal frequency analysis, buckling. Material library (steel, aluminum, ABS, brass, titanium, nylon). Color-coded results visualization with safety factor plots.
119
-
120
- **Assembly** — 7 joint types (rigid, revolute, slider, cylindrical, pin-slot, planar, ball). Joint limits and animation. Interference detection. Exploded views. Motion study. Auto-generated BOM.
121
-
122
- **AI** — Text-to-CAD with natural language. Part identification from geometry. Manufacturing cost estimation. Auto-generated assembly instructions. Maintenance scheduling. Smart BOM with McMaster-Carr links. Works offline.
123
-
124
- **Export** — STL (ASCII + binary), OBJ, glTF 2.0, STEP, DXF, PDF. 3D print slicer integration. G-code preview.
125
-
126
- **Platform** — Chrome, Safari, Firefox, Edge. Offline via IndexedDB. Mobile touch viewer. 50+ keyboard shortcuts. Multi-language (EN/DE/FR/ES/IT/NL).
127
-
128
- ---
45
+ ## 12 Killer Features
46
+
47
+ - ⚡ **Text-to-CAD** — Natural language to 3D geometry with live preview
48
+ - 📷 **Photo-to-CAD** — Phone photo to parametric model via edge detection + AI
49
+ - 🏭 **Manufacturability (DFM)** — Instant feedback for 9 processes, 20+ materials
50
+ - 🧬 **Generative Design** — SIMP topology optimization with live voxel visualization
51
+ - 🔬 **Multi-Physics Simulation** — FEA, thermal, modal, drop test — all in-browser
52
+ - 🔩 **Smart Parts Library** — 200+ standard parts with AI-powered fuzzy search
53
+ - 🧲 **Smart Assembly Mating** — Auto-detect 8 constraint types, motion study
54
+ - 🤖 **Auto-Assemble Parts** — AI geometry fingerprinting, one-click assembly
55
+ - 📊 **Parametric from Example** — Upload variants, AI infers parameters
56
+ - 📡 **Digital Twin Live Data** — IoT sensors (MQTT/REST/WebSocket) on 3D model
57
+ - 🖨️ **Machine Control** — G-code generator for FDM, CNC, laser. OctoPrint/Klipper
58
+ - 📓 **Engineering Notebook** — Auto-logs every design action, AI summaries
129
59
 
130
60
  ## Agent API
131
61
 
132
- cycleCAD is built for AI agents, not just humans. 55 commands across 10 namespaces via JSON-RPC.
62
+ cycleCAD is built for AI agents. 55 commands across 10 namespaces via JSON-RPC.
133
63
 
134
64
  ```javascript
135
65
  // In browser
136
66
  await kernel.exec('ops.box', { width: 100, height: 50, depth: 30 });
137
67
  await kernel.exec('ops.fillet', { edges: [0, 1, 2], radius: 5 });
138
68
  await kernel.exec('step.export', { filename: 'part.step' });
69
+ ```
139
70
 
140
- // Via MCP server
141
- npx cyclecad-mcp # exposes all 55 commands as MCP tools
142
-
143
- // Via REST API
144
- curl -X POST http://localhost:3001/api/exec \
145
- -d '{"command": "ops.box", "params": {"width": 100}}'
71
+ ```bash
72
+ # Via MCP server
73
+ npx cyclecad-mcp
146
74
 
147
- // Via CLI
75
+ # Via CLI
148
76
  cyclecad ops.box --width 100 --height 50 --depth 30
149
77
  ```
150
78
 
151
- ---
79
+ ```bash
80
+ # Via REST API
81
+ curl -X POST http://localhost:3001/api/exec \
82
+ -d '{"command": "ops.box", "params": {"width": 100}}'
83
+ ```
152
84
 
153
- ## Multiplayer
85
+ ## Docker
154
86
 
155
- ```javascript
156
- const room = await cyclecad.createRoom(); // "ABC123"
157
- await cyclecad.joinRoom("ABC123"); // teammate joins
87
+ ```bash
88
+ docker compose up # starts cycleCAD + STEP converter + ExplodeView
158
89
  ```
159
90
 
160
- Peer-to-peer via WebRTC. No server. CRDT sync.
91
+ ## Features
161
92
 
162
- ---
93
+ **Modeling** — Parametric sketcher with 17 tools, 12 constraint types. Extrude, revolve, sweep, loft, shell, fillet, chamfer, boolean, pattern, mirror, draft, hole, thread, rib.
163
94
 
164
- ## Docker
95
+ **B-Rep Kernel** — Real solid geometry via OpenCascade.js WASM. True edge fillets and chamfers. Real boolean operations. STEP import/export.
165
96
 
166
- ```bash
167
- docker compose up # starts cycleCAD + STEP converter + cycleWASH viewer
168
- ```
97
+ **Drawing** — 2D engineering drawing workspace with orthographic views, section views, detail views, GD&T, title blocks, BOM tables. Export to PDF, DXF, SVG.
169
98
 
170
- Three services: cycleCAD on `:8080`, STEP converter on `:8787`, ExplodeView on `:3000`.
99
+ **Simulation** — Static stress (FEA), thermal, modal frequency, buckling. Material library. Color-coded results with safety factor plots.
171
100
 
172
- ---
101
+ **Assembly** — 7 joint types, joint limits, animation, interference detection, exploded views, motion study, auto-generated BOM.
173
102
 
174
- ## Parts Library
103
+ **AI** — Text-to-CAD, part identification, manufacturing cost estimation, auto-generated assembly instructions, maintenance scheduling.
175
104
 
176
- 35+ built-in parametric parts. Community marketplace with 70-90% creator royalties.
105
+ **Export** — STL (ASCII + binary), OBJ, glTF 2.0, STEP, DXF, PDF. G-code preview. 3D print slicer integration.
177
106
 
178
- ```bash
179
- cyclecad install bearing-6205
180
- cyclecad install motor-nema23
181
- ```
107
+ **Platform** — Chrome, Safari, Firefox, Edge. Offline via IndexedDB. Mobile touch viewer. 50+ keyboard shortcuts. Multi-language (EN/DE/FR/ES/IT/NL).
182
108
 
183
- ---
109
+ ## Pricing
110
+
111
+ | Free | Pro €49/mo | Enterprise €299/mo |
112
+ |---|---|---|
113
+ | All 12 killer features | Everything in Free | Everything in Pro |
114
+ | Text-to-CAD + Photo-to-CAD | STEP import/export | Self-hosted deployment |
115
+ | DFM + simulation | Real-time collaboration | SSO / SAML |
116
+ | 200+ standard parts | Cloud storage | SLA guarantee |
117
+ | STL/OBJ/glTF export | Machine control | MCP server + REST API |
184
118
 
185
119
  ## Contributing
186
120
 
@@ -191,15 +125,10 @@ cd cyclecad && npm run dev
191
125
 
192
126
  Pick a `good-first-issue`, make changes, open a PR.
193
127
 
194
- ---
195
-
196
128
  ## License
197
129
 
198
- MIT &copy; [Sachin Kumar](https://github.com/vvlars-cmd)
130
+ MIT © Sachin Kumar
131
+
132
+ ---
199
133
 
200
- <div align="center">
201
- <br>
202
- <a href="https://cyclecad.com/app/"><strong>Open cycleCAD</strong></a>
203
- <br><br>
204
- <sub>Built for <a href="https://cyclewash.com">cycleWASH</a> — designing a real production machine with 400 parts.</sub>
205
- </div>
134
+ **Built for [cycleWASH](https://cyclewash.de)** — designing real production machines with 400+ parts.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cyclecad",
3
- "version": "3.9.11",
3
+ "version": "3.9.12",
4
4
  "description": "Browser-based parametric 3D CAD modeler with AI-powered tools, native Inventor file parsing, and smart assembly management. No install required.",
5
5
  "main": "index.html",
6
6
  "bin": {
package/~$cycleCAD-Architecture-v2.pptx DELETED
Binary file