mnemosyne-core 2.0.2 → 2.1.0

package/README.md

@@ -12,8 +12,8 @@ Your knowledge. One SQLite file. Accessible to you and your agents.
 
 ```bash
 npm install -g mnemosyne-core
-mnemosyne init
-mnemosyne start
+mnemosyne init --data-dir ./data
+mnemosyne start --data-dir ./data
 # Open http://localhost:7321/dashboard
 ```
 
@@ -29,6 +29,17 @@ Mnemosyne is an **exocortex** — an external brain that belongs to you.
 
 ---
 
+## Naming Guide
+
+| Term | Everyday Meaning |
+|---|---|
+| **Project** | A folder or workspace (e.g. "Work", "Personal") |
+| **Atom** | A note, idea, or document |
+| **Block** | A paragraph, snippet, or file attachment inside an atom |
+| **Bond** | A link or relationship between two atoms |
+
+---
+
 ## Features
 
 | Feature | What it does |
@@ -50,16 +61,16 @@ Mnemosyne is an **exocortex** — an external brain that belongs to you.
 
 ```bash
 npm install -g mnemosyne-core
-mnemosyne init
-mnemosyne start
+mnemosyne init --data-dir ./data
+mnemosyne start --data-dir ./data
 ```
 
 **Or in your project:**
 
 ```bash
 npm install mnemosyne-core
-npx mnemosyne init
-npx mnemosyne start
+npx mnemosyne init --data-dir ./data
+npx mnemosyne start --data-dir ./data
 ```
 
 **Requirements:** Node.js 20+
@@ -77,7 +88,7 @@ Add to `claude_desktop_config.json`:
   "mcpServers": {
     "mnemosyne": {
       "command": "npx",
-      "args": ["mnemosyne-core", "start", "--mcp-transport", "stdio"]
+      "args": ["mnemosyne-core", "start", "--data-dir", "./data", "--mcp-transport", "stdio"]
     }
   }
 }
@@ -88,7 +99,7 @@ Restart Claude Desktop → Settings → MCP → Mnemosyne appears with all tools
 ### Cursor (SSE — server mode)
 
 ```bash
-mnemosyne start --port 7321
+mnemosyne start --data-dir ./data --port 7321
 ```
 
 Then in Cursor: Settings → MCP → Add server → `http://localhost:7321/mcp/manifest`
@@ -99,16 +110,30 @@ Then in Cursor: Settings → MCP → Add server → `http://localhost:7321/mcp/m
 import { MnemosyneClient } from 'mnemosyne-core/sdk';
 
 const client = new MnemosyneClient({ baseUrl: 'http://localhost:7321' });
-const atoms = await client.searchSemantic('server setup', { limit: 5 });
+
+// Create a project
+const { project } = await client.createProject({ name: 'Work Notes' });
+
+// Create an atom (a note)
+const { atom } = await client.createAtom({
+  project_id: project.id,
+  title: 'Meeting Notes',
+  type: 'text',
+});
+
+// Search by keyword
+const results = await client.searchKeyword('meeting');
+console.log(`Found ${results.count} results`);
 ```
 
+See **[WORKING_EXAMPLE.md](WORKING_EXAMPLE.md)** for a complete runnable walkthrough.
+
 ### Embedded (your own app)
 
 ```typescript
 import { Mnemosyne, ApiRouter, McpServer } from 'mnemosyne-core';
 
-const brain = new Mnemosyne();
-await brain.init();
+const brain = new Mnemosyne({ dbPath: './data/nexus.db' });
 
 const api = new ApiRouter(brain.store);
 const mcp = new McpServer(brain.store);
@@ -150,23 +175,15 @@ server.on('request', (req, res) => api.handle(req, res));
 
 ---
 
-## Documentation
-
-- **[Getting Started](docs/getting-started.md)** — Install, first project, search, export
-- **[Agent Setup](docs/agent-setup.md)** — Claude Desktop, Cursor, SDK, permissions
-- **[API Reference](docs/04-developer-guide/api-reference.md)** — REST endpoints
-- **[Architecture](docs/04-developer-guide/architecture.md)** — Database schema, design decisions
-
----
-
 ## CLI Commands
 
 ```bash
-mnemosyne init          # Scaffold data/ directory + config.yaml + SQLite DB
-mnemosyne start         # Start server (API + dashboard + MCP SSE)
-mnemosyne start --mcp-transport stdio   # Stdio mode for Claude Desktop
-mnemosyne migrate --from v1.json --to data/nexus.db   # v1.0 → v2.0
-mnemosyne export --project "Work" --format markdown   # Export project
+mnemosyne init --data-dir ./data          # Scaffold data/ + config.yaml + DB
+mnemosyne start --data-dir ./data         # Start server (API + dashboard + MCP SSE)
+mnemosyne start --data-dir ./data --mcp-transport stdio   # Stdio for Claude Desktop
+mnemosyne doctor --data-dir ./data        # Diagnostics: deps, config, DB health
+mnemosyne migrate --from v1.json --to data/nexus.db       # v1.0 → v2.0
+mnemosyne export --project "Work" --format markdown       # Export project
 ```
 
 ---

package/dist/{Store-BtdYuiUx.d.mts → Store-BJ8b6xbs.d.mts}

@@ -208,6 +208,7 @@ declare class Store extends EventEmitter {
     getProject(id: string): Project | undefined;
     getProjectByName(name: string): Project | undefined;
     getProjects(): Project[];
+    deleteProject(id: string): boolean;
     createAtom(projectId: string, title: string, type: string, createdBy: string, opts?: {
         parentId?: string;
         summary?: string;
@@ -244,6 +245,7 @@ declare class Store extends EventEmitter {
         outgoing: Bond[];
         incoming: Bond[];
     };
+    getAllBonds(): Bond[];
     updateBond(id: string, fields: {
         label?: string;
         color?: string;

package/dist/{Store-BtdYuiUx.d.ts → Store-BJ8b6xbs.d.ts}

@@ -208,6 +208,7 @@ declare class Store extends EventEmitter {
     getProject(id: string): Project | undefined;
     getProjectByName(name: string): Project | undefined;
     getProjects(): Project[];
+    deleteProject(id: string): boolean;
     createAtom(projectId: string, title: string, type: string, createdBy: string, opts?: {
         parentId?: string;
         summary?: string;
@@ -244,6 +245,7 @@ declare class Store extends EventEmitter {
         outgoing: Bond[];
         incoming: Bond[];
     };
+    getAllBonds(): Bond[];
     updateBond(id: string, fields: {
         label?: string;
         color?: string;