← Codebase Guide | ← Previous: Maintainer Playbook

Reference Map

Use this appendix when you need to trace documentation and source files to their purpose. It is a map, not a substitute for source code or DOCS.md.

Main documents

Document	Use
README.md	Landing, quickstart, product model, main links.
DOCS.md	Complete technical reference: schema, endpoints, MCP tools, CLI/cloud.
CONTRIBUTING.md	Contribution flow and general standards.
SECURITY.md	Security reporting.
CHANGELOG.md	Change history.
docs/ARCHITECTURE.md	Existing architecture, lifecycle, CLI reference, cloud/dashboard routes.
docs/AGENT-SETUP.md	Per-agent setup, project detection, compaction survival.
docs/PLUGINS.md	OpenCode/Claude plugin details and current limits.
docs/INSTALLATION.md	Platform installation.
docs/DOCTOR.md	Operational diagnosis and repair.
docs/COMPARISON.md	Comparison with alternatives.
docs/BETA_TESTING.md	Isolated beta flows.
docs/intended-usage.md	Expected usage/product framing.
docs/engram-cloud/README.md	Cloud landing.
docs/engram-cloud/quickstart.md	Recommended cloud path.
docs/engram-cloud/troubleshooting.md	Cloud failures and recovery.
docs/CODEBASE-GUIDE.md	Codebase guide landing page and reading path.
docs/codebase/*.md	Split codebase guide pages by topic.

Main source files

File/directory	Why it matters
cmd/engram/main.go	Main binary wiring.
cmd/engram/cloud.go	Cloud subcommands and runtime.
cmd/engram/doctor.go	CLI doctor.
cmd/engram/conflicts.go	Conflicts CLI.
internal/store/store.go	Local persistence core.
internal/store/relations.go	Memory relationships/judgments.
internal/mcp/mcp.go	MCP tools and profiles.
internal/mcp/activity.go	MCP activity/session tracking.
internal/server/server.go	Local JSON API.
internal/sync/sync.go	Chunks, manifest, import/export, bootstrap.
internal/sync/transport.go	Sync transport abstraction.
internal/cloud/config.go	Cloud config from environment.
internal/cloud/chunkcodec/	Chunk canonicalization, IDs, and mutation payload decoding.
internal/cloud/remote/transport.go	Remote sync/mutations client.
internal/cloud/autosync/manager.go	Background push/pull manager.
internal/cloud/cloudserver/cloudserver.go	Cloud HTTP runtime + dashboard mount.
internal/cloud/cloudserver/mutations.go	Cloud mutation endpoints/contract.
internal/cloud/cloudstore/cloudstore.go	Postgres cloud store.
internal/cloud/cloudstore/dashboard_queries.go	Dashboard read model.
internal/cloud/cloudstore/project_controls.go	Per-project sync controls.
internal/cloud/cloudstore/audit_log.go	Cloud/dashboard audit.
internal/cloud/auth/auth.go	Bearer/session auth.
internal/cloud/dashboard/dashboard.go	Dashboard routes and handlers.
internal/cloud/dashboard/static/styles.css	Dashboard styles.
internal/project/detect.go	Project detection.
internal/project/similar.go	Name similarity/consolidation.
internal/setup/setup.go	Integration installation.
internal/tui/	Bubbletea TUI.
internal/diagnostic/	Operational checks/repair.
internal/llm/	Runners for semantic scanning with agent CLIs.
internal/obsidian/	Obsidian beta export/watch/hub.
plugin/opencode/engram.ts	OpenCode adapter.
plugin/claude-code/	Claude Code plugin, hooks, and skill.
plugin/obsidian/	Experimental Obsidian plugin.
skills/	Agent contribution rules.
openspec/	Per-change specs/designs/tasks.

Related codebase guide pages

Page	Purpose
Mental Model	What Engram is/is not and the 90-second architecture model.
Repository Map	Package ownership and placement rules.
Memory Core	Store entities, save/retrieve flow, and invariants.
Interfaces	CLI, MCP, local API, and TUI responsibilities.
Sync and Cloud	Chunk sync, cloud sync, autosync, transport, and cloudstore.
Dashboard	Browser dashboard architecture and invariant.
Integrations	Agent integrations, thin plugin principle, and setup boundaries.
Maintainer Playbook	Capabilities, navigation, guardrails, checklists, and review playbook.

---

← Previous: Maintainer Playbook | ← Codebase Guide