project-memory
v0.1.0
Published
Local-first Project Memory: scoped indexing, embeddings, Cursor integration
Downloads
193
Readme
Project Memory
Local-first project understanding for Cursor: scoped indexing, embeddings, and Cursor integration.
Quick start
Option A — Run tasks (easiest)
Open this repo in Cursor/VS Code, then Terminal → Run Task (or Cmd+Shift+B for default build task) and pick:
- Project Memory: Init — create
.mem/config.ymland.memignore - Project Memory: Scaffold — Phase 1: start Qdrant, build index, start memory server (default build task)
Then in Cursor: Command Palette → Project Memory: Attach to Chat.
Option B — npm scripts
From the repo root:
npm install && npm run build
npm run mem:init
npm run mem:scaffoldOption C — CLI directly
From any repo where you’ve run mem init (or from this repo):
node packages/cli/bin/mem.js init
node packages/cli/bin/mem.js scaffoldRequirements
- Node.js 18+
- Docker and Docker Compose (for Qdrant)
Documentation
| Topic | Doc | |-------|-----| | Commands (tasks, scripts, CLI) | docs/commands.md | | Configuration (config.yml, .memignore, defaults) | docs/configuration.md | | Packages (CLI, server, extension) | docs/packages.md | | Testing (run tests, coverage) | docs/testing.md | | Development (build, run services) | docs/development.md | | Publishing (npm + extension, use in other projects) | docs/publishing.md |
All docs live under docs/.
