Contributing
Where each kind of thing lives in the source.
Where each kind of thing lives, written from the table the source's own layering test reads. The source is grouped by what a file is responsible for, and a package imports its own layer and the layers below it, never one above:configuration (what a hop says: its keys, the environment, the endpoints and the addresses it is built from); scope (which objects and rows a hop carries); persistence (state that outlives a process: checkpoints, the audit record, the run's own files, the undo); safety (who may write, what must not leak, what keeps a mover from writing twice); execution (the running of work: processes, ranges, retries, pacing, stalls, sizing of what runs at once); conversion (a value or an object as another engine takes it: canonical text, transforms, types, stored code); reporting (what the operator reads: the verdict, the result shape, the log, the metrics, the notices); decision (choosing: the rungs, the cost model, the joint plan, what each engine can do); engines (the contract every engine fills and each engine's own adapter); integrations (the programs, libraries and provider APIs migkit wraps, and the other tools it meets); workflows (a move's phases and what they do around the move: copy, follow, prove, repair, cut over, recover); cli (the command line and the guide that asks for two addresses); web (the web view and its API); tools (the generators, the full suite and the checks run by the maintainers; they import migkit and migkit never imports them). data (the files migkit ships as resources).
The packages, lowest first
| Package | Layer | Files | What it holds |
|---|---|---|---|
configuration | 1 | 11 | what a hop says: its keys, the environment, the endpoints and the addresses it is built from |
scope | 2 | 5 | which objects and rows a hop carries |
persistence | 3 | 18 | state that outlives a process: checkpoints, the audit record, the run's own files, the undo |
safety | 4 | 12 | who may write, what must not leak, what keeps a mover from writing twice |
execution | 5 | 17 | the running of work: processes, ranges, retries, pacing, stalls, sizing of what runs at once |
conversion | 6 | 69 | a value or an object as another engine takes it: canonical text, transforms, types, stored code |
reporting | 7 | 14 | what the operator reads: the verdict, the result shape, the log, the metrics, the notices |
decision | 8 | 36 | choosing: the rungs, the cost model, the joint plan, what each engine can do |
engines | 9 | 80 | the contract every engine fills and each engine's own adapter |
integrations | 9 | 23 | the programs, libraries and provider APIs migkit wraps, and the other tools it meets |
workflows | 10 | 111 | a move's phases and what they do around the move: copy, follow, prove, repair, cut over, recover |
cli | 11 | 4 | the command line and the guide that asks for two addresses |
web | 11 | 30 | the web view and its API |
tools | - | 13 | the generators, the full suite and the checks run by the maintainers; they import migkit and migkit never imports them |
data | - | 5 | the files migkit ships as resources |
Finding your way
docs/agents/CODEMAP.md: every module in one line, and the places most changes touch.docs/agents/INVENTORY.md: every file with its package, owner, importers, what it reaches and the tests that reach it.docs/agents/LAYERS.md: the layering rule and the upward imports still listed, each with its reason.docs/agents/STATE.md: what each engine can do and what is left.