Skip to main content
Glama
Ngoctrong102

lucad

by Ngoctrong102
README.md
# lucad

Agent-assisted CAD engineering: deterministic **engine** + thin **MCP**.
The engine has **zero** LLM runtime dependency (DEC-002 / NFR-001).

## Install

```bash
curl -fsSL "https://raw.githubusercontent.com/Ngoctrong102/lucad/main/install.sh" | bash
```

From a clone (editable, same isolated venv — **not** a project `.venv`):

```bash
./install.sh
```

```bash
lucad upgrade      # later: pull latest into the CLI venv
lucad uninstall    # remove the CLI (this checkout stays)
```

## Use

```bash
cd your-project    # host machine/job (any name); not the CLI venv
lucad init         # or: lucad init /path/to/host
```

That’s it — host folders (`drawings/`, `artifacts/handoff`, `artifacts/preview`, `plan/`, `.lucad/`) plus `.cursor/mcp.json`. Does **not** create a project `.venv`.

Restart Cursor (`Developer: Reload Window`). Settings → MCP → `lucad-cad` should be green.

Then in Agent chat: design brief → **`plan/` notebook** → gates → `cad_execute` → `cad_validate` → `cad_export`.

## Layout

```
your-project/
  plan/                  ← engineering notebook (many YAML files; commit this)
  drawings/              ← live FreeCAD
  artifacts/handoff/     ← STEP
  artifacts/preview/     ← STL/GLB
  .lucad/                ← ledger (engine only)
  parts/  assemblies/    ← kit templates
  .cursor/mcp.json
```

## Docs

- [`docs/README.md`](docs/README.md)
- [`cad_mcp/README.md`](cad_mcp/README.md)