@pyxmate/memory 0.20.5 → 0.21.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Pyxmate
+Copyright (c) 2025-2026 Pyx-Corp
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,69 +1,98 @@
 # @pyxmate/memory
 
-SDK for **pyx-memory** — Memory as a Service for AI agents.
+SDK + CLI for **pyx-memory** — Memory as a Service for AI agents.
 
-Provides an HTTP client, shared types, and optional dashboard + React hooks for interacting with the pyx-memory managed cloud.
+This package ships:
+
+- **`pyx-mem` CLI** — log in once, install the MCP server into Claude Code (or any
+  MCP-aware host), inspect status, diagnose problems. Credentials live in the OS
+  credential store; no plaintext token files.
+- **`MemoryClient` HTTP SDK** — programmatic Node/Bun client for pyx-memory.
+- **Headless dashboard + React hooks** — `@pyxmate/memory/dashboard`,
+  `@pyxmate/memory/react`.
 
 ## Install
 
 ```bash
+npm install -g @pyxmate/memory
+# or, in a project:
 npm install @pyxmate/memory
 ```
 
-## Setup Claude Code Skills
+ESM-only. Node ≥ 18. Native credential storage via
+[`@napi-rs/keyring`](https://www.npmjs.com/package/@napi-rs/keyring) (macOS
+Keychain, Linux libsecret / Secret Service, Windows Credential Manager). If a
+package manager omitted optional binaries, re-install with
+`npm install --include=optional`.
 
-If you use [Claude Code](https://docs.anthropic.com/en/docs/claude-code), run this command to install pyx-memory integration skills:
+## Use it from Claude Code
 
 ```bash
-npx @pyxmate/memory init
+pyx-mem login
+pyx-mem mcp install claude-code --scope user
 ```
 
-This copies skill files into `.claude/skills/pyx-memory/` so Claude Code auto-discovers pyx-memory patterns, types, and API reference when working in your project.
+Restart Claude Code. The 7 memory tools (`search_memories`, `store_memory`,
+`get_memory`, `list_memories`, `delete_memory`, `ingest_memory_file`,
+`summarize_memory_entity`) are auto-discovered via MCP Tool Search.
 
-## Usage
+Drop the [agent-template snippet](https://github.com/pyx-corp/pyx-memory-v1/blob/main/docs/agent-template.md)
+into your project's `CLAUDE.md` / `AGENTS.md` to tell the agent WHEN to search
+vs store.
 
-```ts
-import { MemoryClient } from '@pyxmate/memory';
-import type { MemoryEntry } from '@pyxmate/memory';
+See the [getting-started guide](https://github.com/pyx-corp/pyx-memory-v1/blob/main/packages/sdk/docs/getting-started.md)
+for the full CLI contract and exit codes.
 
-// Simple: URL + API key
-const client = new MemoryClient('https://your-pyx-memory-endpoint', process.env.MEMORY_API_KEY);
+## Use it programmatically
 
-// Multi-tenant: URL + options with default headers
-const client = new MemoryClient('https://your-pyx-memory-endpoint', {
-  apiKey: process.env.MEMORY_API_KEY,
-  defaultHeaders: { 'X-Tenant-Id': 'tenant-abc' },
-});
+```ts
+import { MemoryClient } from '@pyxmate/memory';
 
-await client.initialize();
+const memory = new MemoryClient('https://memory.api.pyxmate.com', process.env.MEMORY_API_KEY);
+await memory.initialize();
 
-// Store a memory
-await client.store({
-  content: 'The project deadline is March 15th',
-  agentId: 'my-agent',
+await memory.store({
+  content: 'The project deadline is 2026-03-15',
+  metadata: { topic: 'planning', project: 'orca', source: 'agent' },
 });
 
-// Search memories — smart retrieval picks the best strategy
-const results = await client.search({ query: 'deadline', limit: 5 });
+const results = await memory.search({ query: 'deadline', limit: 5 });
 ```
 
 ## Entry Points
 
-| Import | Description |
+| Import | What you get |
 |--------|-------------|
-| `@pyxmate/memory` | Core SDK — `MemoryClient`, shared types, constants |
-| `@pyxmate/memory/dashboard` | Headless dashboard utilities — `DashboardClient`, aggregations, graph transforms (no React) |
-| `@pyxmate/memory/react` | React hooks — `useMemoryStats`, `useMemoryHealth`, `useKnowledgeGraph`, etc. (requires React >= 18) |
+| `@pyxmate/memory` | `MemoryClient`, shared types, constants |
+| `@pyxmate/memory/dashboard` | Headless dashboard utilities — aggregations, graph transforms (no React) |
+| `@pyxmate/memory/react` | React hooks — `useMemoryStats`, `useMemoryHealth`, `useKnowledgeGraph` (requires React ≥ 18) |
 
-## Managed Cloud
+Bin entry: `pyx-mem`.
+
+## Docs
 
-pyx-memory is deployed exclusively as a managed cloud service at **[memory.pyxmate.com](https://memory.pyxmate.com)**.
+These links point at the source repo because the npm tarball ships only the
+built `dist/` (no markdown docs):
 
-## Requirements
+- [getting-started](https://github.com/pyx-corp/pyx-memory-v1/blob/main/packages/sdk/docs/getting-started.md) — CLI + SDK quickstart, exit codes
+- [advanced](https://github.com/pyx-corp/pyx-memory-v1/blob/main/packages/sdk/docs/advanced.md) — RAG strategies, bi-temporal queries, confidence/abstention
+- [types](https://github.com/pyx-corp/pyx-memory-v1/blob/main/packages/sdk/docs/types.md) — public TypeScript types
+- [consumer-patterns](https://github.com/pyx-corp/pyx-memory-v1/blob/main/packages/sdk/docs/consumer-patterns.md) — how to wire `MemoryClient` into a consumer project
+- [parity](https://github.com/pyx-corp/pyx-memory-v1/blob/main/packages/sdk/docs/parity.md) — embedded vs sidecar feature parity
+- [agent-template](https://github.com/pyx-corp/pyx-memory-v1/blob/main/docs/agent-template.md) — `CLAUDE.md` / `AGENTS.md` snippet
+- [file-ingestion](https://github.com/pyx-corp/pyx-memory-v1/blob/main/docs/file-ingestion.md) — file/image ingest caveats
+- [access-control](https://github.com/pyx-corp/pyx-memory-v1/blob/main/docs/access-control.md) — multi-tenant, ReBAC, sensitivity
+- [http-api](https://github.com/pyx-corp/pyx-memory-v1/blob/main/docs/http-api.md) — HTTP endpoints reference
+
+## Managed Cloud
 
-- ESM only (`"type": "module"`)
-- React >= 18 (optional, only for `@pyxmate/memory/react`)
+pyx-memory is deployed as a managed cloud service at
+**[memory.pyxmate.com](https://memory.pyxmate.com)**.
 
 ## License
 
-MIT
+MIT. This SDK package and its bundled `client`/`shared`/`dashboard` code are
+MIT-licensed; see [LICENSE](./LICENSE). The repository as a whole is a
+mixed-license monorepo — server, engine, and internal apps are proprietary. See
+the [per-package license map](https://github.com/pyx-corp/pyx-memory-v1/blob/main/LICENSES/README.md)
+for the full mapping.

package/dist/chunk-7P6ASYW6.mjs

@@ -0,0 +1,9 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+export {
+  __export
+};