Metadata-Version: 2.4
Name: gitcad
Version: 0.9.11
Summary: Headless, git-native B-rep CAD (metapackage: core, mechanical, and electrical)
Project-URL: Homepage, https://gitcad.xyz
Project-URL: Repository, https://github.com/gitcad-xyz/gitcad
Project-URL: Issues, https://github.com/gitcad-xyz/gitcad/issues
Author-email: Dan Willis <danielcwillis@gmail.com>
License-Expression: Apache-2.0
Keywords: brep,cad,eda,git,headless,mcp
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Manufacturing
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Requires-Python: >=3.10
Requires-Dist: gitcad-core==0.9.11
Requires-Dist: gitcad-ecad==0.9.11
Requires-Dist: gitcad-mech==0.9.11
Requires-Dist: mcp>=1.0
Description-Content-Type: text/markdown

# gitcad

Headless, git-native B-rep CAD — mechanical and electrical.

Models are stored as canonical text; geometry is a build artifact. Entity
identity is derived from construction lineage rather than ordinal position.
Each build produces a report.

This metapackage installs:

- `gitcad-core` — canonical text, identity, the Part standard, report pipeline.
- `gitcad-mech` — document model, geometry kernel, sketches, drawings, importers.
- `gitcad-ecad` — schematic and ERC, board and DRC, fabrication outputs.

## Install

```
pip install gitcad            # core, mechanical, electrical, MCP server, native kernel
```

The mechanical geometry kernel uses exact rational arithmetic. Its native
(compiled) build is installed by default on common platforms; elsewhere the
pure-Python build is used.

## Now what

gitcad is an MCP server — there is no application to open. Wire it into an
MCP client (either form):

```
claude mcp add gitcad -- gitcad-mcp
```

```json
{ "mcpServers": { "gitcad": { "command": "gitcad-mcp" } } }
```

Once connected, the agent calls the `get_started` tool and opens the live
browser viewer (`viewer_open`). Run `gitcad` (or `python -m gitcad`) any time
to reprint this wiring and the viewer story.

- **Windows per-user installs:** console scripts land in
  `%APPDATA%\Python\PythonXY\Scripts`, typically not on PATH, so `gitcad-mcp`
  can be "not recognized" right after install. Use the PATH-proof spelling
  `{ "mcpServers": { "gitcad": { "command": "python", "args": ["-m", "gitcad.mcp"] } } }`
  or add that Scripts directory to PATH.
- **Introspection:** `gitcad` is a namespace package shared by the three
  subpackages. Without the metapackage installed, `gitcad.__file__` is
  `None` — use `gitcad.__path__` or `importlib.metadata`, never
  `os.path.dirname(gitcad.__file__)`. The metapackage provides
  `gitcad.__version__`.

## Console commands

`gitcad` (this guide), `gitcad-init`, `gitcad-render`, `gitcad-view`,
`gitcad-review`, `gitcad-merge`, `gitcad-verify`, `gitcad-convert`,
`gitcad-explore`, `gitcad-mcp`, `gitcad-lot`.

License: Apache-2.0. https://gitcad.xyz · https://github.com/gitcad-xyz/gitcad
