memories-dev

Developer guide for contributing to the memories.sh monorepo.

Project Structure

memories/
├── packages/
│   ├── cli/                  # @memories.sh/cli (npm package)
│   │   ├── src/
│   │   │   ├── commands/     # CLI commands (Commander.js)
│   │   │   ├── lib/          # Core: db, memory, auth, embeddings, git
│   │   │   └── mcp/          # MCP server (stdio + HTTP)
│   │   ├── tsup.config.ts    # Build config
│   │   └── package.json
│   └── web/                  # Next.js marketing + dashboard
│       ├── src/app/          # App Router pages + API routes
│       ├── src/components/   # UI components (shadcn/ui)
│       ├── src/lib/          # Auth, Stripe, Supabase, Turso
│       └── content/docs/     # Fumadocs documentation
├── supabase/                 # Database migrations
├── skills/                   # Distributable skills (this directory)
└── pnpm-workspace.yaml

Architecture Overview

Dependency Graph

db.ts (SQLite/libSQL, migrations, FTS5)
  ↓
memory.ts (CRUD, context, lifecycle sessions, compaction, consolidation, streaming)
  ↑          ↑            ↑
openclaw-memory.ts   reminders.ts   embeddings.ts (Xenova/Transformers, cosine similarity)
  ↑          ↑
git.ts    openclaw.ts command bridge
  ↓
Commands ← auth.ts, turso.ts, config.ts, setup.ts
  ↓
MCP Server (stdio + StreamableHTTP transports)
  ↳ registerCoreTools (core + lifecycle + consolidation + reminders)
  ↳ registerStreamingTools (SSE chunk pipelines)

Key Lib Files

Database Schema

SQLite with FTS5 full-text search:

• memories — Main table: id, content, type, tags, scope, projectid, createdat, updatedat, deletedat
• memories_fts — FTS5 virtual table, synced via triggers
• memoryembeddings — Vector storage: memoryid, embedding (JSON float array), model
• memorylinks — Bidirectional links: id1, id2, linktype
• memoryhistory — Version tracking: memoryid, version, content, tags, change_type
• memory_sessions — Explicit session state (scope, status, last activity, metadata)
• memorysessionevents — Session turn/checkpoint/event log with meaningful flag
• memorysessionsnapshots — Raw markdown transcript snapshots keyed by trigger/slug
• memorycompactionevents — Write-ahead compaction audit trail
• memoryconsolidationruns — Consolidation run metadata and counts

Lifecycle Model (Current)

1. Session start: startMemorySession() creates memory_sessions row and can preload OpenClaw bootstrap context when file mode is enabled.
2. Checkpointing: checkpointMemorySession() records meaningful events in memorysessionevents.
3. Compaction guard: writeAheadCompactionCheckpoint() writes a checkpoint before destructive context compaction and logs memorycompactionevents.
4. Snapshots: createMemorySessionSnapshot() stores raw markdown snapshots in DB and optionally mirrors to OpenClaw snapshot files.
5. Consolidation: consolidateMemories() merges duplicates/supersedes stale entries and records memoryconsolidationruns.

Adding a New CLI Command

1. Create packages/cli/src/commands/mycommand.ts:

import { Command } from "commander";

export const myCommand = new Command("mycommand")
  .description("What it does")
  .argument("<required>", "Description")
  .option("-f, --flag <value>", "Description", "default")
  .action(async (required, opts) => {
    // Use lib functions from ../lib/
    // Use ui.ts for styled output
  });

1. Register in packages/cli/src/index.ts:

import { myCommand } from "./commands/mycommand.js";
program.addCommand(myCommand);

1. Add tests in packages/cli/src/commands/mycommand.test.ts.

Adding a New MCP Tool

Edit packages/cli/src/mcp/tools.ts (and streaming-tools.ts for chunked ingestion):

server.tool(
  "tool_name",
  "Description of what the tool does",
  {
    param: z.string().describe("Parameter description"),
  },
  async ({ param }) => {
    // Implementation
    return {
      content: [{ type: "text", text: "Result" }],
    };
  }
);

Parameters use Zod schemas. Return { isError: true } for errors.

Notes:

• Register in registerCoreTools() for standard/lifecycle tools.
• Keep cloud-vs-local behavior explicit when adding tools that rely on local-only tables or file paths.

Adding a New Generation Target

1. Add template to packages/cli/src/lib/templates.ts
2. Register in the generation targets map
3. Add detection in packages/cli/src/lib/setup.ts
4. Add docs page in packages/web/content/docs/integrations/

Build & Test

pnpm build          # Build all packages
pnpm typecheck      # TypeScript checks
pnpm test           # Run all tests (vitest)

# CLI-specific
cd packages/cli
pnpm dev            # Watch mode (tsup)
pnpm test           # CLI tests only

# Web-specific
cd packages/web
pnpm dev            # Next.js dev server
pnpm build          # Production build

Tech Stack

Reference Files

• Architecture deep-dive: See [references/architecture.md](references/architecture.md) for detailed module descriptions and data flow