GitM documentation¶

GitM is a SolidWorks add-in that turns a GitHub repository into a lightweight PDM (Product Data Management) system. It adds a task pane to SolidWorks for checking files out and in, tracking versions, managing locks, and collaborating with a team — using Git and Git LFS underneath.

This documentation is internal and private. It describes what GitM does today, including rough edges and known gaps. It is not marketing material.

Looking for GitMCloud docs? → GitMCloud documentation

GitMCloud is a separate companion app that GitM depends on for onboarding access checks, the part-number registry, and the browser-based BOM / assembly viewer. It has its own section — open the link above.

Pick your path¶

I design parts in SolidWorks¶

You already have GitM installed and want to get work done — check out a part, edit it, check it back in, see versions, work with branches.

Start here: Getting started — a five-minute first run.
Then browse the Designer guide.
Background reading: Concepts.

I set up GitM for a team (CAD admin)¶

You install GitM, choose a profile, and manage team settings like the part-number toggle, locks, and .gitm.json.

Start here: CAD admin guide.

I deploy software across machines (IT admin)¶

You roll the installer out to many workstations, handle prerequisites, and make sure the client can reach GitMCloud.

Start here: IT admin guide.
Before anything else: Prepare GitMCloud before installing.

I'm installing GitM on one workstation¶

Start here: Installation.

I build and ship GitM + GitMCloud (publisher)¶

You are the one party who produces and operates GitM — you compile the add-in, build the installer, deploy GitMCloud, register the GitHub apps, and own the accounts. This is not a customer role.

Start here: Publisher guide.
Moving accounts: Migrate the publisher account.

Reference¶

Task pane tour — the five tabs and the top bar.
Settings reference — every settings field.
Files and locations — where GitM stores things.
Terminology — the words the UI uses.
Known limitations and discrepancies — honest list of gaps, bugs, and places the docs/PRD disagree with the code.

What GitM is not (today)¶

Not a replacement for SolidWorks PDM Professional. No data cards, no workflow state machines, no approval gates beyond GitHub.
Not a merge tool for CAD. Binary files cannot be merged; conflicts are resolved as "use mine" or "use theirs."
Not cross-platform. Windows and SolidWorks only.
Not usable without GitMCloud reachable — onboarding is gated by a GitMCloud access check. See Connect to GitMCloud.