memobank-cli 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +139 -0
- package/LICENSE +21 -0
- package/README.md +300 -0
- package/dist/cli.d.ts +7 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +294 -0
- package/dist/cli.js.map +1 -0
- package/dist/commands/capture.d.ts +12 -0
- package/dist/commands/capture.d.ts.map +1 -0
- package/dist/commands/capture.js +191 -0
- package/dist/commands/capture.js.map +1 -0
- package/dist/commands/import.d.ts +28 -0
- package/dist/commands/import.d.ts.map +1 -0
- package/dist/commands/import.js +356 -0
- package/dist/commands/import.js.map +1 -0
- package/dist/commands/index.d.ts +12 -0
- package/dist/commands/index.d.ts.map +1 -0
- package/dist/commands/index.js +82 -0
- package/dist/commands/index.js.map +1 -0
- package/dist/commands/install.d.ts +16 -0
- package/dist/commands/install.d.ts.map +1 -0
- package/dist/commands/install.js +142 -0
- package/dist/commands/install.js.map +1 -0
- package/dist/commands/lifecycle.d.ts +21 -0
- package/dist/commands/lifecycle.d.ts.map +1 -0
- package/dist/commands/lifecycle.js +106 -0
- package/dist/commands/lifecycle.js.map +1 -0
- package/dist/commands/map.d.ts +10 -0
- package/dist/commands/map.d.ts.map +1 -0
- package/dist/commands/map.js +72 -0
- package/dist/commands/map.js.map +1 -0
- package/dist/commands/onboarding.d.ts +10 -0
- package/dist/commands/onboarding.d.ts.map +1 -0
- package/dist/commands/onboarding.js +420 -0
- package/dist/commands/onboarding.js.map +1 -0
- package/dist/commands/recall.d.ts +13 -0
- package/dist/commands/recall.d.ts.map +1 -0
- package/dist/commands/recall.js +89 -0
- package/dist/commands/recall.js.map +1 -0
- package/dist/commands/review.d.ts +11 -0
- package/dist/commands/review.d.ts.map +1 -0
- package/dist/commands/review.js +66 -0
- package/dist/commands/review.js.map +1 -0
- package/dist/commands/search.d.ts +13 -0
- package/dist/commands/search.d.ts.map +1 -0
- package/dist/commands/search.js +107 -0
- package/dist/commands/search.js.map +1 -0
- package/dist/commands/setup.d.ts +9 -0
- package/dist/commands/setup.d.ts.map +1 -0
- package/dist/commands/setup.js +354 -0
- package/dist/commands/setup.js.map +1 -0
- package/dist/commands/write.d.ts +14 -0
- package/dist/commands/write.d.ts.map +1 -0
- package/dist/commands/write.js +247 -0
- package/dist/commands/write.js.map +1 -0
- package/dist/config.d.ts +19 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +147 -0
- package/dist/config.js.map +1 -0
- package/dist/core/decay-engine.d.ts +16 -0
- package/dist/core/decay-engine.d.ts.map +1 -0
- package/dist/core/decay-engine.js +91 -0
- package/dist/core/decay-engine.js.map +1 -0
- package/dist/core/embedding.d.ts +60 -0
- package/dist/core/embedding.d.ts.map +1 -0
- package/dist/core/embedding.js +169 -0
- package/dist/core/embedding.js.map +1 -0
- package/dist/core/lifecycle-manager.d.ts +105 -0
- package/dist/core/lifecycle-manager.d.ts.map +1 -0
- package/dist/core/lifecycle-manager.js +332 -0
- package/dist/core/lifecycle-manager.js.map +1 -0
- package/dist/core/memory-template.d.ts +70 -0
- package/dist/core/memory-template.d.ts.map +1 -0
- package/dist/core/memory-template.js +496 -0
- package/dist/core/memory-template.js.map +1 -0
- package/dist/core/noise-filter.d.ts +39 -0
- package/dist/core/noise-filter.d.ts.map +1 -0
- package/dist/core/noise-filter.js +168 -0
- package/dist/core/noise-filter.js.map +1 -0
- package/dist/core/retriever.d.ts +21 -0
- package/dist/core/retriever.d.ts.map +1 -0
- package/dist/core/retriever.js +77 -0
- package/dist/core/retriever.js.map +1 -0
- package/dist/core/sanitizer.d.ts +9 -0
- package/dist/core/sanitizer.d.ts.map +1 -0
- package/dist/core/sanitizer.js +57 -0
- package/dist/core/sanitizer.js.map +1 -0
- package/dist/core/smart-extractor.d.ts +12 -0
- package/dist/core/smart-extractor.d.ts.map +1 -0
- package/dist/core/smart-extractor.js +102 -0
- package/dist/core/smart-extractor.js.map +1 -0
- package/dist/core/store.d.ts +40 -0
- package/dist/core/store.d.ts.map +1 -0
- package/dist/core/store.js +233 -0
- package/dist/core/store.js.map +1 -0
- package/dist/core/tool-config.d.ts +33 -0
- package/dist/core/tool-config.d.ts.map +1 -0
- package/dist/core/tool-config.js +253 -0
- package/dist/core/tool-config.js.map +1 -0
- package/dist/engines/engine-adapter.d.ts +22 -0
- package/dist/engines/engine-adapter.d.ts.map +1 -0
- package/dist/engines/engine-adapter.js +7 -0
- package/dist/engines/engine-adapter.js.map +1 -0
- package/dist/engines/lancedb-engine.d.ts +55 -0
- package/dist/engines/lancedb-engine.d.ts.map +1 -0
- package/dist/engines/lancedb-engine.js +279 -0
- package/dist/engines/lancedb-engine.js.map +1 -0
- package/dist/engines/text-engine.d.ts +30 -0
- package/dist/engines/text-engine.d.ts.map +1 -0
- package/dist/engines/text-engine.js +100 -0
- package/dist/engines/text-engine.js.map +1 -0
- package/dist/platforms/claude-code.d.ts +13 -0
- package/dist/platforms/claude-code.d.ts.map +1 -0
- package/dist/platforms/claude-code.js +85 -0
- package/dist/platforms/claude-code.js.map +1 -0
- package/dist/platforms/codex.d.ts +9 -0
- package/dist/platforms/codex.d.ts.map +1 -0
- package/dist/platforms/codex.js +102 -0
- package/dist/platforms/codex.js.map +1 -0
- package/dist/platforms/cursor.d.ts +9 -0
- package/dist/platforms/cursor.d.ts.map +1 -0
- package/dist/platforms/cursor.js +112 -0
- package/dist/platforms/cursor.js.map +1 -0
- package/dist/types.d.ts +55 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +6 -0
- package/dist/types.js.map +1 -0
- package/package.json +87 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
### Planned
|
|
11
|
+
|
|
12
|
+
- Web UI for memory management
|
|
13
|
+
- Memory sharing and collaboration features
|
|
14
|
+
- Advanced search filters
|
|
15
|
+
- Memory export formats (PDF, HTML)
|
|
16
|
+
|
|
17
|
+
## [0.1.0] - 2026-03-19
|
|
18
|
+
|
|
19
|
+
### Added
|
|
20
|
+
|
|
21
|
+
#### Core Features
|
|
22
|
+
- **Interactive Onboarding** - Menu-driven setup with arrow key navigation
|
|
23
|
+
- `memo onboarding` command (aliases: `memo init`, `memo setup`)
|
|
24
|
+
- Quick Setup (automated recommended configuration)
|
|
25
|
+
- Custom Setup (step-by-step configuration)
|
|
26
|
+
- Platform selection with checkboxes
|
|
27
|
+
- Embedding provider selection
|
|
28
|
+
|
|
29
|
+
- **Memory Lifecycle Management**
|
|
30
|
+
- Access tracking for all recalled memories
|
|
31
|
+
- Three-tier system (core/working/peripheral)
|
|
32
|
+
- Automatic archival suggestions
|
|
33
|
+
- Correction tracking with review flagging
|
|
34
|
+
- `memo lifecycle` command suite
|
|
35
|
+
- `memo correct <path>` command
|
|
36
|
+
|
|
37
|
+
- **Memory Import**
|
|
38
|
+
- Import from Claude Code auto-memory
|
|
39
|
+
- Import from Gemini CLI GEMINI.md
|
|
40
|
+
- Import from Qwen Code QWEN.md
|
|
41
|
+
- `memo import` command with dry-run support
|
|
42
|
+
|
|
43
|
+
- **Security Features**
|
|
44
|
+
- Automatic secret sanitization (20+ patterns)
|
|
45
|
+
- PII detection and redaction
|
|
46
|
+
- Abstraction level validation
|
|
47
|
+
- Noise filtering for low-value content
|
|
48
|
+
- Value scoring system (0-1 scale)
|
|
49
|
+
|
|
50
|
+
- **Embedding Support**
|
|
51
|
+
- Ollama local embeddings (no API key)
|
|
52
|
+
- OpenAI embeddings
|
|
53
|
+
- Azure OpenAI embeddings
|
|
54
|
+
- Custom embedding endpoints
|
|
55
|
+
|
|
56
|
+
#### Platform Integrations
|
|
57
|
+
- Claude Code (autoMemoryDirectory)
|
|
58
|
+
- Codex (AGENTS.md protocol)
|
|
59
|
+
- Cursor (.cursor/rules/memobank.mdc)
|
|
60
|
+
|
|
61
|
+
#### Commands
|
|
62
|
+
- `memo onboarding` - Interactive setup
|
|
63
|
+
- `memo init` - Alias for onboarding
|
|
64
|
+
- `memo import` - Import memories
|
|
65
|
+
- `memo lifecycle` - Lifecycle management
|
|
66
|
+
- `memo correct` - Record corrections
|
|
67
|
+
- `memo recall` - Search and display
|
|
68
|
+
- `memo search` - Debug search
|
|
69
|
+
- `memo write` - Create memories
|
|
70
|
+
- `memo capture` - Extract learnings
|
|
71
|
+
- `memo index` - Build index
|
|
72
|
+
- `memo review` - List due reviews
|
|
73
|
+
- `memo map` - Show statistics
|
|
74
|
+
|
|
75
|
+
#### Documentation
|
|
76
|
+
- `docs/ONBOARDING-GUIDE.md` - Interactive setup guide
|
|
77
|
+
- `docs/MEMORY-VALUE-GUIDE.md` - What to remember
|
|
78
|
+
- `docs/LIFECYCLE-MANAGEMENT.md` - Memory optimization
|
|
79
|
+
- `CONTRIBUTING.md` - Contribution guidelines
|
|
80
|
+
- `CHANGELOG.md` - This file
|
|
81
|
+
|
|
82
|
+
### Changed
|
|
83
|
+
|
|
84
|
+
- Unified setup flow (`memo onboarding` replaces separate `memo setup`)
|
|
85
|
+
- Simplified `memo install` (directory structure only)
|
|
86
|
+
- Improved error messages with actionable guidance
|
|
87
|
+
- Enhanced TypeScript strict mode compliance
|
|
88
|
+
- Updated LanceDB from `vectordb` to `@lancedb/lancedb`
|
|
89
|
+
|
|
90
|
+
### Fixed
|
|
91
|
+
|
|
92
|
+
- LanceDB search API compatibility (`toArray()` vs `execute()`)
|
|
93
|
+
- Memory file generation with proper filename format
|
|
94
|
+
- Import command sanitization before saving
|
|
95
|
+
- Various TypeScript type errors
|
|
96
|
+
- Undefined value handling in commands
|
|
97
|
+
|
|
98
|
+
### Technical
|
|
99
|
+
|
|
100
|
+
- **Dependencies**
|
|
101
|
+
- `@lancedb/lancedb` ^0.15.0
|
|
102
|
+
- `@lancedb/core` ^0.15.0
|
|
103
|
+
- `openai` ^4.104.0
|
|
104
|
+
- `ink` ^3.2.0 (for future interactive UI)
|
|
105
|
+
- `ink-select-input` ^4.2.0
|
|
106
|
+
|
|
107
|
+
- **Dev Dependencies**
|
|
108
|
+
- `@types/jest` ^29.5.12
|
|
109
|
+
- `jest` ^29.7.0
|
|
110
|
+
- `ts-jest` ^29.1.2
|
|
111
|
+
- `eslint` ^8.57.0
|
|
112
|
+
- `prettier` ^3.2.5
|
|
113
|
+
- `@typescript-eslint/*` ^7.0.0
|
|
114
|
+
|
|
115
|
+
- **Quality**
|
|
116
|
+
- 25 unit tests (100% core module coverage)
|
|
117
|
+
- ESLint configuration
|
|
118
|
+
- Prettier formatting
|
|
119
|
+
- TypeScript strict mode
|
|
120
|
+
- CI/CD workflows (GitHub Actions)
|
|
121
|
+
|
|
122
|
+
### Removed
|
|
123
|
+
|
|
124
|
+
- `docs/specs/` directory (design spec references)
|
|
125
|
+
- `docs/plans/` directory (planning documents)
|
|
126
|
+
- Deprecated setup command flow
|
|
127
|
+
|
|
128
|
+
## [0.0.1] - 2026-03-17
|
|
129
|
+
|
|
130
|
+
### Added
|
|
131
|
+
|
|
132
|
+
- Initial prototype
|
|
133
|
+
- Basic text search engine
|
|
134
|
+
- Memory CRUD operations
|
|
135
|
+
- YAML frontmatter parsing
|
|
136
|
+
- Markdown file storage
|
|
137
|
+
|
|
138
|
+
[Unreleased]: https://github.com/clawde-agent/memobank-cli/compare/v0.1.0...HEAD
|
|
139
|
+
[0.1.0]: https://github.com/clawde-agent/memobank-cli/releases/tag/v0.1.0
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Memobank Project
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,300 @@
|
|
|
1
|
+
# Memobank CLI
|
|
2
|
+
|
|
3
|
+
> Persistent memory for AI coding sessions
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/memobank-cli)
|
|
6
|
+
[](https://www.npmjs.com/package/memobank-cli)
|
|
7
|
+
[](https://opensource.org/licenses/MIT)
|
|
8
|
+
[](https://www.typescriptlang.org/)
|
|
9
|
+
[](https://nodejs.org/)
|
|
10
|
+
|
|
11
|
+
**Memobank CLI** is a personal AI memory system for coding agents. It provides persistent project memory (lessons, decisions, workflows, architecture) with automatic recall and capture.
|
|
12
|
+
|
|
13
|
+
## 🚀 Quick Start
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Install globally
|
|
17
|
+
npm install -g memobank-cli
|
|
18
|
+
|
|
19
|
+
# Interactive setup (recommended)
|
|
20
|
+
memo onboarding
|
|
21
|
+
|
|
22
|
+
# Or quick setup
|
|
23
|
+
memo install --all
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## ✨ Features
|
|
27
|
+
|
|
28
|
+
- 🧠 **Automatic Recall** — Relevant memories injected at session start
|
|
29
|
+
- 💾 **Structured Storage** — Markdown files with YAML frontmatter, Git-native
|
|
30
|
+
- ⏳ **Decay Scoring** — Weibull-based relevance decay for recency prioritization
|
|
31
|
+
- 🔍 **Hybrid Search** — Text engine (keyword + tag + decay) with optional LanceDB vector search
|
|
32
|
+
- 🛡️ **Secret Sanitization** — Automatic redaction of API keys, tokens, PII, etc. (20+ patterns)
|
|
33
|
+
- 🤖 **LLM Extraction** — Turn session summaries into structured memories
|
|
34
|
+
- 🔌 **Multi-Platform** — Claude Code, Codex, Cursor, Gemini CLI, Qwen Code
|
|
35
|
+
- 📦 **Zero-Dependency** — Text engine works out-of-the-box
|
|
36
|
+
- 🌍 **Local Embeddings** — Ollama support (no API key needed)
|
|
37
|
+
- 📥 **Memory Import** — Import from Claude Code, Gemini CLI, Qwen Code
|
|
38
|
+
- 📊 **Lifecycle Management** — Track access patterns, archive inactive memories
|
|
39
|
+
|
|
40
|
+
## 📋 Commands
|
|
41
|
+
|
|
42
|
+
### Setup & Configuration
|
|
43
|
+
|
|
44
|
+
| Command | Description |
|
|
45
|
+
|---------|-------------|
|
|
46
|
+
| `memo onboarding` | Interactive setup wizard (recommended) |
|
|
47
|
+
| `memo init` | Alias for onboarding |
|
|
48
|
+
| `memo install` | Set up directory structure |
|
|
49
|
+
| `memo import` | Import memories from other AI tools |
|
|
50
|
+
|
|
51
|
+
### Memory Operations
|
|
52
|
+
|
|
53
|
+
| Command | Description |
|
|
54
|
+
|---------|-------------|
|
|
55
|
+
| `memo recall <query>` | Search and display memories (writes to MEMORY.md) |
|
|
56
|
+
| `memo search <query>` | Debug search without modifying MEMORY.md |
|
|
57
|
+
| `memo write <type>` | Create a new memory (interactive or non-interactive) |
|
|
58
|
+
| `memo capture` | Extract learnings from session text |
|
|
59
|
+
|
|
60
|
+
### Management
|
|
61
|
+
|
|
62
|
+
| Command | Description |
|
|
63
|
+
|---------|-------------|
|
|
64
|
+
| `memo index` | Build/update search index |
|
|
65
|
+
| `memo review` | List memories due for review |
|
|
66
|
+
| `memo map` | Show memory statistics |
|
|
67
|
+
| `memo lifecycle` | View memory lifecycle report |
|
|
68
|
+
| `memo correct <path>` | Record a memory correction |
|
|
69
|
+
|
|
70
|
+
## 🎯 Usage Examples
|
|
71
|
+
|
|
72
|
+
### First Time Setup
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
# Interactive setup with menu navigation
|
|
76
|
+
memo onboarding
|
|
77
|
+
|
|
78
|
+
# Quick automated setup
|
|
79
|
+
memo install --all
|
|
80
|
+
|
|
81
|
+
# Configure specific platforms
|
|
82
|
+
memo install --claude-code
|
|
83
|
+
memo install --cursor
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Create Memories
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
# Interactive (opens editor)
|
|
90
|
+
memo write lesson
|
|
91
|
+
|
|
92
|
+
# Non-interactive
|
|
93
|
+
memo write lesson \
|
|
94
|
+
--name="redis-pooling" \
|
|
95
|
+
--description="Use connection pooling for Redis" \
|
|
96
|
+
--tags="redis,database" \
|
|
97
|
+
--content="## Problem\n\nHigh concurrency exhausts connections.\n\n## Solution\n\nUse connection pool with max=10."
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Search Memories
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
# Text search
|
|
104
|
+
memo recall "redis connection"
|
|
105
|
+
|
|
106
|
+
# Vector search (if configured)
|
|
107
|
+
memo recall "database pooling" --engine=lancedb
|
|
108
|
+
|
|
109
|
+
# Filter by tag
|
|
110
|
+
memo search "redis" --tag=database
|
|
111
|
+
|
|
112
|
+
# Filter by type
|
|
113
|
+
memo search "pool" --type=lesson
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Lifecycle Management
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
# View lifecycle report
|
|
120
|
+
memo lifecycle report
|
|
121
|
+
|
|
122
|
+
# View by tier
|
|
123
|
+
memo lifecycle --tier core
|
|
124
|
+
memo lifecycle --tier peripheral
|
|
125
|
+
|
|
126
|
+
# View archival candidates
|
|
127
|
+
memo lifecycle archive
|
|
128
|
+
|
|
129
|
+
# View flagged memories (multiple corrections)
|
|
130
|
+
memo lifecycle flagged
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Import from Other Tools
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
# Import from Claude Code
|
|
137
|
+
memo import --claude
|
|
138
|
+
|
|
139
|
+
# Import from Gemini CLI
|
|
140
|
+
memo import --gemini
|
|
141
|
+
|
|
142
|
+
# Import from Qwen Code
|
|
143
|
+
memo import --qwen
|
|
144
|
+
|
|
145
|
+
# Import from all available tools
|
|
146
|
+
memo import --all
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
## 📁 Memory Types
|
|
150
|
+
|
|
151
|
+
| Type | Directory | Purpose |
|
|
152
|
+
|------|-----------|---------|
|
|
153
|
+
| **Lesson** | `lessons/` | Post-mortems, bugs fixed, gotchas |
|
|
154
|
+
| **Decision** | `decisions/` | ADRs: context, options, decision, consequences |
|
|
155
|
+
| **Workflow** | `workflows/` | Runbooks, deploy flows, onboarding |
|
|
156
|
+
| **Architecture** | `architecture/` | System diagrams, component descriptions |
|
|
157
|
+
|
|
158
|
+
### Memory File Format
|
|
159
|
+
|
|
160
|
+
```markdown
|
|
161
|
+
---
|
|
162
|
+
name: api-timeout-handling
|
|
163
|
+
type: lesson
|
|
164
|
+
description: "Use async job queue to prevent API timeout"
|
|
165
|
+
tags: [api, reliability, async]
|
|
166
|
+
created: 2026-03-17
|
|
167
|
+
review_after: 90d
|
|
168
|
+
confidence: medium
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
## Problem
|
|
172
|
+
|
|
173
|
+
[Describe the problem]
|
|
174
|
+
|
|
175
|
+
## Solution
|
|
176
|
+
|
|
177
|
+
[Describe the solution]
|
|
178
|
+
|
|
179
|
+
## Key Takeaways
|
|
180
|
+
|
|
181
|
+
- [Key insight 1]
|
|
182
|
+
- [Key insight 2]
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
## ⚙️ Configuration
|
|
186
|
+
|
|
187
|
+
Configuration lives in `meta/config.yaml`:
|
|
188
|
+
|
|
189
|
+
```yaml
|
|
190
|
+
project:
|
|
191
|
+
name: "my-project"
|
|
192
|
+
description: "Optional description"
|
|
193
|
+
memory:
|
|
194
|
+
token_budget: 2000
|
|
195
|
+
top_k: 5
|
|
196
|
+
embedding:
|
|
197
|
+
engine: text # or 'lancedb'
|
|
198
|
+
provider: ollama # or 'openai', 'azure'
|
|
199
|
+
model: mxbai-embed-large
|
|
200
|
+
dimensions: 1024
|
|
201
|
+
search:
|
|
202
|
+
use_tags: true
|
|
203
|
+
use_summary: true
|
|
204
|
+
review:
|
|
205
|
+
enabled: true
|
|
206
|
+
lifecycle:
|
|
207
|
+
coreThreshold: 10
|
|
208
|
+
peripheralThreshold: 90
|
|
209
|
+
archiveAfterDays: 180
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Embedding Providers
|
|
213
|
+
|
|
214
|
+
| Provider | Model | Dimensions | API Key |
|
|
215
|
+
|----------|-------|------------|---------|
|
|
216
|
+
| **Ollama** | mxbai-embed-large | 1024 | Not required |
|
|
217
|
+
| **OpenAI** | text-embedding-3-small | 1536 | Required |
|
|
218
|
+
| **Azure** | text-embedding-ada-002 | 1536 | Required |
|
|
219
|
+
|
|
220
|
+
## 🔌 Platform Integrations
|
|
221
|
+
|
|
222
|
+
After running `memo install --all`:
|
|
223
|
+
|
|
224
|
+
### Claude Code
|
|
225
|
+
Sets `autoMemoryDirectory` in `~/.claude/settings.json`
|
|
226
|
+
|
|
227
|
+
### Codex
|
|
228
|
+
Appends memory protocol to `AGENTS.md`
|
|
229
|
+
|
|
230
|
+
### Cursor
|
|
231
|
+
Creates `.cursor/rules/memobank.mdc` with `alwaysApply: true`
|
|
232
|
+
|
|
233
|
+
## 🛡️ Security
|
|
234
|
+
|
|
235
|
+
Memobank automatically sanitizes:
|
|
236
|
+
- ✅ API keys and tokens
|
|
237
|
+
- ✅ Passwords and secrets
|
|
238
|
+
- ✅ IP addresses and hostnames
|
|
239
|
+
- ✅ Email addresses and phone numbers (PII)
|
|
240
|
+
- ✅ Database connection strings
|
|
241
|
+
- ✅ Private keys and certificates
|
|
242
|
+
- ✅ JWT tokens
|
|
243
|
+
- ✅ AWS credentials
|
|
244
|
+
- ✅ GitHub/GitLab tokens
|
|
245
|
+
|
|
246
|
+
## 📊 Memory Lifecycle
|
|
247
|
+
|
|
248
|
+
Memories are automatically categorized:
|
|
249
|
+
|
|
250
|
+
| Tier | Condition | Behavior |
|
|
251
|
+
|------|-----------|----------|
|
|
252
|
+
| **Core** 🔴 | Access ≥10 times | Priority retrieval |
|
|
253
|
+
| **Working** 🟡 | Normal access | Normal retrieval |
|
|
254
|
+
| **Peripheral** ⚪ | 90 days no access | Lower priority, archive suggestion |
|
|
255
|
+
|
|
256
|
+
## 📖 Documentation
|
|
257
|
+
|
|
258
|
+
- [Onboarding Guide](docs/ONBOARDING-GUIDE.md) - Interactive setup walkthrough
|
|
259
|
+
- [Memory Value Guide](docs/MEMORY-VALUE-GUIDE.md) - What to remember
|
|
260
|
+
- [Lifecycle Management](docs/LIFECYCLE-MANAGEMENT.md) - Memory optimization
|
|
261
|
+
|
|
262
|
+
## 🔧 Development
|
|
263
|
+
|
|
264
|
+
```bash
|
|
265
|
+
# Clone and install
|
|
266
|
+
git clone https://github.com/clawde-agent/memobank-cli.git
|
|
267
|
+
cd memobank-cli
|
|
268
|
+
npm install
|
|
269
|
+
|
|
270
|
+
# Build
|
|
271
|
+
npm run build
|
|
272
|
+
|
|
273
|
+
# Run tests
|
|
274
|
+
npm test
|
|
275
|
+
|
|
276
|
+
# Development mode
|
|
277
|
+
npm run dev -- --help
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
## 🤝 Contributing
|
|
281
|
+
|
|
282
|
+
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
283
|
+
|
|
284
|
+
### Areas for Contribution
|
|
285
|
+
|
|
286
|
+
- Unit and integration tests
|
|
287
|
+
- Additional embedding providers
|
|
288
|
+
- Platform integrations (VS Code, JetBrains)
|
|
289
|
+
- Performance optimizations
|
|
290
|
+
- Documentation improvements
|
|
291
|
+
|
|
292
|
+
## 📄 License
|
|
293
|
+
|
|
294
|
+
MIT © 2026 Memobank Project. See [LICENSE](LICENSE) for details.
|
|
295
|
+
|
|
296
|
+
## 🔗 Links
|
|
297
|
+
|
|
298
|
+
- [npm package](https://www.npmjs.com/package/memobank-cli)
|
|
299
|
+
- [GitHub repository](https://github.com/clawde-agent/memobank-cli)
|
|
300
|
+
- [memobank-skill](https://github.com/clawde-agent/memobank-skill) — AI Agent skill
|
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA;;;GAGG"}
|