mirror of
https://github.com/allaunthefox/Research-Stack.git
synced 2026-07-31 03:05:21 +00:00
83 lines
4.1 KiB
Markdown
83 lines
4.1 KiB
Markdown
<div align="center">
|
|
|
|
<img src="assets/text-to-cad-demo.gif" alt="Demo of the text-to-cad harness generating and previewing CAD geometry" width="100%">
|
|
|
|
<br>
|
|
|
|
# ⚙ Open Source Text to CAD Harness ⚙
|
|
|
|
An open source harness for generating 3D models with your favorite coding agent
|
|
|
|
[](https://github.com/earthtojake/text-to-cad/stargazers)
|
|
[](https://github.com/earthtojake/text-to-cad/network/members)
|
|
[](LICENSE)
|
|
[](https://x.com/soft_servo)
|
|
[](requirements-cad.txt)
|
|
[](https://github.com/gumyr/build123d)
|
|
[](requirements-cad.txt)
|
|
[](skills/cad/SKILL.md)
|
|
[](skills/cad/SKILL.md)
|
|
[](skills/urdf/SKILL.md)
|
|
[](viewer/package.json)
|
|
[](viewer/package.json)
|
|
[](viewer/package.json)
|
|
|
|
</div>
|
|
|
|
## ✨ Features
|
|
|
|
- **Generate** - Create source-controlled CAD models with coding agents like Codex and Claude Code.
|
|
- **Export** - Produce STEP, STL, DXF, GLB, topology data, and URDF robot descriptions.
|
|
- **Browse** - Inspect generated geometry in a local CAD Explorer viewer.
|
|
- **Reference** - Copy stable `@cad[...]` references so agents can make precise follow-up edits.
|
|
- **Review** - Render quick snapshots for fast checks during an iteration loop.
|
|
- **Reproduce** - Edit source files first, then regenerate explicit targets.
|
|
- **Local** - Run the harness and viewer locally with no backend to host.
|
|
|
|
## 🧰 Bundled Skills
|
|
|
|
This harness vendors file-targeted skills for CAD and robot-description work. Use the bundled copies here for local `models/` projects, or use the dedicated repositories when installing the skills outside this harness.
|
|
|
|
- **CAD Skill** - STEP, STL, DXF, GLB/topology, snapshots, and `@cad[...]` geometry references. [Bundled docs](skills/cad/README.md) · [Standalone repo](https://github.com/earthtojake/cad-skill)
|
|
- **URDF Skill** - Generated URDF XML, robot links, joints, limits, validation, and mesh references. [Bundled docs](skills/urdf/README.md) · [Standalone repo](https://github.com/earthtojake/urdf-skill)
|
|
|
|
## 🔁 Workflow
|
|
|
|
1. **Describe** - Tell your agent about the part, assembly, fixture, robot, or mechanism you want.
|
|
2. **Edit** - Let your coding agent update CAD source files under `models/`.
|
|
3. **Regenerate** - Create explicit STEP, STL, DXF, GLB, or URDF targets.
|
|
4. **Inspect** - Open the CAD Explorer viewer to review the generated model.
|
|
5. **Reference** - Copy `@cad[...]` handles when you want geometry-aware edits.
|
|
6. **Commit** - Save the source and generated artifacts together once the model is ready.
|
|
|
|
## 🚀 Quick Start
|
|
|
|
Clone the repo:
|
|
|
|
```bash
|
|
git clone https://github.com/earthtojake/text-to-cad.git
|
|
cd text-to-cad
|
|
```
|
|
|
|
Install Python CAD dependencies:
|
|
|
|
```bash
|
|
python3.11 -m venv .venv
|
|
./.venv/bin/python -m pip install --upgrade pip
|
|
./.venv/bin/pip install -r requirements-cad.txt
|
|
```
|
|
|
|
Install viewer dependencies:
|
|
|
|
```bash
|
|
cd viewer
|
|
npm install
|
|
```
|
|
|
|
Run the local CAD Explorer:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Then open [http://localhost:4178](http://localhost:4178).
|