Glossary
The words CADGit uses, in plain English. They are git's words on purpose: if you have used GitHub, nothing here is new.
- Repository
- One project's files and their whole history, kept on the server. A SolidWorks vault or a top-level project folder is usually one repository.
- Branch
- A named line of work. main is the branch everyone shares; it is protected, so changes land on it only through a merge. Other branches are for work in progress.
- Commit
- One saved state of every file on a branch, with who made it and when. In CADGit every push makes one commit, so the words mean the same thing here.
- Push
- Sending your changed files from your machine to the server as a new commit. cadgit push.
- Pull
- Bringing the latest commit of your branch down to your machine. It never overwrites a file you have edited; it stops and tells you.
- Clone
- Copying a repository onto a machine for the first time. cadgit clone.
- Merge
- Landing a branch's changes onto main. If the same file changed on both, that is a conflict and someone picks the winner.
- Conflict
- The same file changed on main and on the branch. CAD files are never stitched together: one whole file wins, the other is kept in the record.
- Missing file
- A part, assembly or drawing that a file in this repository needs, pointing inside the repository folder, but that was never pushed. SolidWorks will ask for it when the file opens on a teammate's machine. Someone who has it should push it.
- Outside the repository
- A reference to a file in a folder that is not under version control, like someone's Desktop or a Google Drive folder. It works for whoever has that file; nobody else gets it from CADGit. The Missing files tab lists these by where they point, for whoever wants to tidy up.
- Lock
- A note that someone has a file open in SolidWorks right now. It warns the team; it does not stop anyone. The cadgit agent keeps it up to date.
- 3D view
- A picture of the model you can rotate in the browser, made on the pushing machine with eDrawings. Best effort: a file without one is still safely stored.
- Drawing PDF
- A drawing's sheets as a PDF you can zoom into in the browser, made on the pushing machine with eDrawings. Drawings get this instead of a 3D view.
- Access token
- A long secret that signs the cadgit command line in on one machine. Make one per machine in Settings; revoke it if the machine goes.
- Workspace
- The folder on your machine that holds a clone. cadgit status there tells you what changed.
- Version
- One file as it was in one commit. Every version is kept byte for byte and can be downloaded or restored.