Skip to content

CODEBASE.md

Latest commit

 

History

History
21 lines (16 loc) · 1.38 KB

CODEBASE.md

File metadata and controls

21 lines (16 loc) · 1.38 KB
Raw

Codebase Map

@merekit/link is a standalone Node CLI that reads mere.link.yaml, resolves entities/projects/surfaces/links, and can plan or apply Mere Projects sync records. The executable entrypoint is src/run.ts; keep it as command routing only.

Key modules:

  • src/manifest.ts: CLI manifest, help text, completion output.
  • src/config/*: YAML loading, normalization, starter config generation, workspace snapshot shaping.
  • src/sync/projects.ts: dry-run/apply planning for Mere Projects records and links.
  • src/runtime/*: argument parsing, paths, output tables, JSON/YAML/subprocess/Executor HTTP boundaries.
  • src/domain/*: shared types, plugin capabilities, scalar guards.
  • src/sync/executor-policy.ts: compiles Link surfaces and policy.writes into Executor policy rules and checks Link-side resource guards before write invocation.

Rules for agents:

  • Do not call JSON.parse, YAML.parse, or spawnSync outside src/runtime/*.
  • Keep Executor HTTP calls in src/runtime/executor.ts; other modules should use the narrow source/tool/policy/invocation helpers.
  • Sync writes must remain dry-run by default and require policy.writes: [sync].
  • Executor writes must also require Link policy, matching resource arguments, and --apply.
  • Preserve existing Mere Project narrative fields; sync updates only attributes for existing records.
  • Run pnpm verify before handing off.