docs / collaboration

Local collaboration gate

Use kernelcad collab check to merge a branch edit onto a chosen Git revision and check the merged candidate against requirements that passed at that revision.

Check a branch edit

Run the check from the repository. Set --base to the revision your edit started from, --head to the current target, and --yours to your branch or a directory containing the model file.

kernelcad collab check --file examples/collab/bracket-and-motor-plate.kcad.ts --base BASE_REF --head origin/develop --yours my-branch --out merged.kcad.ts --json

Replace BASE_REF with the commit where your branch started. Exit code 0 means the merged candidate passed; exit code 1 reports a structural conflict, a rejected gate, or an error. --out writes the merged source only after a pass.

This is a local gate. It does not provide hosted concurrent collaboration or merge changes into GitHub.

Try the example

The example assembles a bracket and motor plate with a shared hole-pattern requirement. Moving one interface hole breaks that requirement; changing the bracket's outer finish keeps it green.

Browse agent workflow demos