Skip to content

Commit b2038a0

Browse files
docs: update README with v0.5.40 onboarding flow and verified claims
1 parent cae34ce commit b2038a0

1 file changed

Lines changed: 97 additions & 33 deletions

File tree

README.md

Lines changed: 97 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
11
# StackMemory
22

3-
**Lossless, project-scoped memory for AI tools** • v0.5.30
3+
**Lossless, project-scoped memory for AI tools** • v0.5.40
44

5-
StackMemory is a **production-ready memory runtime** for AI coding tools that preserves full project context across sessions. With **Phases 1-4 complete**, it delivers:
5+
StackMemory is a **production-ready memory runtime** for AI coding tools that preserves full project context across sessions:
66

7-
- **89-98% faster** task operations than manual tracking
8-
- **10,000+ frame depth** support with hierarchical organization
7+
- **Zero-config setup** - `stackmemory init` just works, no questions asked
8+
- **26 MCP tools** for Claude Code integration
99
- **Full Linear integration** with bidirectional sync
10-
- **20+ MCP tools** for Claude Code
1110
- **Context persistence** that survives /clear operations
12-
- **Two-tier storage system** with local tiers and infinite remote storage
13-
- **Smart compression** (LZ4/ZSTD) with 2.5-3.5x ratios
14-
- **Background migration** with configurable triggers
15-
- **396 tests passing** with standardized error handling
16-
- **npm v0.5.30** published with WhatsApp notifications and improved integrations
11+
- **Hierarchical frame organization** (nested call stack model)
12+
- **490 tests passing** with comprehensive coverage
1713

1814
Instead of a linear chat log, StackMemory organizes memory as a **call stack** of scoped work (frames), with intelligent LLM-driven retrieval and team collaboration features.
1915

@@ -120,46 +116,76 @@ The editor never manages memory directly; it asks StackMemory for the **context
120116

121117
# QuickStart
122118

123-
## 1. Hosted (Recommended)
124-
125-
### Step 1: Create a project
119+
## 1. Install & Initialize (30 seconds)
126120

127121
```bash
128-
stackmemory projects create \
129-
--repo https://github.com/org/repo
122+
# Install globally
123+
npm install -g @stackmemoryai/stackmemory
124+
125+
# Initialize in your project (zero-config, just works)
126+
cd your-project
127+
stackmemory init
128+
129+
# Configure Claude Code integration
130+
stackmemory setup-mcp
131+
132+
# Verify everything works
133+
stackmemory doctor
130134
```
131135

132-
This creates a **project-scoped memory space** tied to the repo.
136+
That's it! Restart Claude Code and StackMemory MCP tools are available.
133137

134138
---
135139

136-
### Step 2: Install StackMemory
140+
## 2. Detailed Setup
141+
142+
### Install
137143

138144
```bash
139-
npm install -g @stackmemoryai/stackmemory@0.5.30
140-
# or latest
141145
npm install -g @stackmemoryai/stackmemory@latest
142146
```
143147

144-
---
148+
During install, you'll be asked if you want to install Claude Code hooks (optional but recommended).
145149

146-
### Step 3: Setup Claude Code Integration (Automated)
150+
### Initialize Project
147151

148152
```bash
149-
# Automatic setup - configures MCP and session hooks
150-
npm run claude:setup
153+
cd your-project
154+
stackmemory init
151155
```
152156

153-
This automatically:
157+
This creates `.stackmemory/` with SQLite storage. No questions asked.
158+
159+
For interactive setup with more options:
160+
```bash
161+
stackmemory init --interactive
162+
```
154163

164+
### Configure Claude Code
165+
166+
```bash
167+
stackmemory setup-mcp
168+
```
169+
170+
This automatically:
155171
- Creates `~/.claude/stackmemory-mcp.json` MCP configuration
156-
- Sets up session initialization hooks
157172
- Updates `~/.claude/config.json` with StackMemory integration
173+
- Validates the configuration
174+
175+
### Diagnose Issues
176+
177+
```bash
178+
stackmemory doctor
179+
```
158180

159-
**Manual setup alternative:**
181+
Checks project initialization, database integrity, MCP config, and suggests fixes.
182+
183+
---
184+
185+
## 3. Advanced Setup
160186

161187
<details>
162-
<summary>Click to expand manual setup steps</summary>
188+
<summary>Manual MCP configuration</summary>
163189

164190
Create MCP configuration:
165191

@@ -178,7 +204,7 @@ cat > ~/.claude/stackmemory-mcp.json << 'EOF'
178204
EOF
179205
```
180206

181-
Update Claude config:
207+
Update Claude config.json:
182208

183209
```json
184210
{
@@ -190,6 +216,26 @@ Update Claude config:
190216

191217
</details>
192218

219+
<details>
220+
<summary>Hosted mode (cloud storage)</summary>
221+
222+
```bash
223+
stackmemory onboard
224+
# Select "Hosted" when prompted
225+
# Or set DATABASE_URL environment variable
226+
```
227+
228+
</details>
229+
230+
<details>
231+
<summary>ChromaDB for semantic search</summary>
232+
233+
```bash
234+
stackmemory init --chromadb
235+
# Prompts for ChromaDB API key
236+
```
237+
238+
</details>
193239

194240
Claude Code sessions automatically capture tool calls, maintain context across sessions, and sync with Linear when configured.
195241

@@ -409,8 +455,13 @@ stackmemory skills rlm "Build, test, and publish version 2.0.0"
409455
## CLI Commands
410456

411457
```bash
412-
# Core
413-
stackmemory init # Initialize project
458+
# Setup & Diagnostics
459+
stackmemory init # Initialize project (zero-config)
460+
stackmemory init --interactive # Interactive setup with options
461+
stackmemory setup-mcp # Configure Claude Code MCP
462+
stackmemory doctor # Diagnose issues and suggest fixes
463+
464+
# Status
414465
stackmemory status # Current status
415466
stackmemory progress # Recent activity
416467

@@ -455,20 +506,33 @@ stackmemory mcp-server [--port 3001]
455506
- Hosted: **Private beta**
456507
- OSS mirror: **Production ready**
457508
- MCP integration: **Stable**
458-
- CLI: **v0.5.30** - Full task, context, Linear, and storage management
509+
- CLI: **v0.5.40** - Zero-config setup, diagnostics, full task/context/Linear management
459510
- Two-tier storage: **Complete**
460-
- Test Suite: **396 tests passing**
511+
- Test Suite: **490 tests passing**
461512

462513
---
463514

464515
## Changelog
465516

517+
### v0.5.40 (2026-01-27)
518+
- **Zero-config onboarding**: `stackmemory init` now works without any prompts
519+
- **New `setup-mcp` command**: Auto-configures Claude Code MCP integration
520+
- **New `doctor` command**: Diagnoses issues and suggests fixes
521+
- **Interactive postinstall**: Asks for consent before modifying ~/.claude
522+
- **Better error messages**: Shows reason + fix + next step
523+
- 490 tests passing
524+
525+
### v0.5.39 (2026-01-27)
526+
- **AsyncMutex**: Thread-safe Linear sync with stale lock detection
527+
- **Action timeout**: 60s timeout for SMS action execution
528+
- **Persistent rate limiting**: Survives server restarts
529+
- **Atomic file writes**: Prevents corruption on crash
530+
466531
### v0.5.30 (2026-01-26)
467532
- Standardized error handling with `IntegrationError`, `DatabaseError`, `ValidationError`
468533
- Adopted error classes across Linear integration (12 files)
469534
- Adopted error classes across database layer (6 files)
470535
- WhatsApp notifications with session ID and interactive options
471-
- 396 tests passing with improved code quality
472536

473537
### v0.5.28 (2026-01-25)
474538
- WhatsApp flag for claude-sm automatic notifications

0 commit comments

Comments
 (0)