skills/gentleman-programming/engram/engram-architecture-guardrails

engram-architecture-guardrails

SKILL.md

When to Use

Use this skill when:

  • Adding a new subsystem or major package
  • Moving responsibilities between local store, cloud, dashboard, or plugins
  • Changing sync flow, source-of-truth rules, or persistence boundaries

Core Guardrails

  1. Local SQLite is the source of truth; cloud is replication and shared access.
  2. Keep plugin/adaptor layers thin; real behavior belongs in Go packages.
  3. Prefer explicit boundaries: store, cloudstore, server, dashboard, autosync.
  4. New features must fit the existing local-first mental model before they fit the UI.
  5. Do not hide cross-system coupling inside helpers or templates.

Decision Rules

  • Local-only concern -> internal/store
  • Cloud materialization or org-wide control -> internal/cloud/cloudstore
  • HTTP contract or enforcement -> internal/cloud/cloudserver
  • Browser rendering and UX -> internal/cloud/dashboard
  • Background orchestration -> internal/cloud/autosync

Validation

  • Add regression tests for every boundary change.
  • Verify local, remote, and dashboard behavior still tell the same product story.
  • If the change touches sync, test both push and pull paths.
Weekly Installs
6
GitHub Stars
1.4K
First Seen
8 days ago
Installed on
opencode6
mcpjam5
roo5
gemini-cli5
windsurf5
zencoder5