mcpField
E
engram-architecture-guardrails

engram-architecture-guardrails

github.com/gentleman-programmingDevelopment7.7k73 installsUpdated today
Repository

About engram-architecture-guardrails

An architecture skill for developers adding subsystems or changing Engram's storage, cloud, dashboard, plugin, or sync boundaries. It defines component responsibilities and calls for regression tests across local, remote, and dashboard behavior.

Key features

  1. 01Local SQLite as source of truth
  2. 02Explicit store and cloud boundaries
  3. 03Thin plugin and adapter layers
  4. 04Guidance for assigning responsibilities
  5. 05Regression testing for boundary changes

Use cases

  1. 01Adding a subsystem or major package
  2. 02Changing persistence or source-of-truth rules
  3. 03Modifying sync flows across local and cloud

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/gentleman-programming/engram --skill engram-architecture-guardrails

After installing, type/engram-architecture-guardrailsin Claude Code to confirm it loaded.

Details

From the project README

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.

Comments

Markdown supported