You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): add skills, hooks, and spec system usage guidelines
Update README with Skills System (/spec, /linear-run), Hooks
(automatic task tracking, skill-eval, PROMPT_PLAN auto-progress),
and Prompt Forge sections. Add hook templates for on-task-complete,
skill-eval, and skill-rules.json to auto-install during npm install.
Update package.json keywords and description for npm discoverability.
-**490 tests passing** with comprehensive coverage
17
+
-**Skills system** with `/spec` and `/linear-run` for Claude Code
18
+
-**Automatic hooks** for task tracking, Linear sync, and spec progress
19
+
-**498 tests passing** with comprehensive coverage
18
20
19
21
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.
20
22
@@ -34,13 +36,13 @@ Tools forget decisions and constraints between sessions. StackMemory makes conte
34
36
35
37
## Features (at a glance)
36
38
37
-
- MCP tools for Claude Code: 26+ tools; context on every request
38
-
-Safe branches: worktree isolation with `--worktree` or `-w`
StackMemory ships Claude Code skills that integrate directly into your workflow. Skills are invoked via `/skill-name` in Claude Code or `stackmemory skills <name>` from the CLI.
139
+
140
+
### Spec Generator (`/spec`)
141
+
142
+
Generates iterative spec documents following a 4-doc progressive chain. Each document reads previous ones from disk for context.
StackMemory installs Claude Code hooks that run automatically during your session. Hooks are non-blocking and fail silently to never interrupt your workflow.
When you type a prompt, the `skill-eval` hook scores it against `skill-rules.json` (28 mapped skills with keyword, pattern, intent, and directory matching). Skills scoring above the threshold (default: 3) are recommended.
209
+
210
+
```json
211
+
// Example: user types "generate a spec for the auth system"
212
+
// skill-eval recommends:
213
+
{
214
+
"recommendedSkills": [
215
+
{ "skillName": "spec-generator", "score": 8 },
216
+
{ "skillName": "frame-management", "score": 5 }
217
+
]
218
+
}
219
+
```
220
+
221
+
### Hook Installation
222
+
223
+
Hooks install automatically during `npm install` (with user consent). To install or reinstall manually:
224
+
225
+
```bash
226
+
# Automatic (prompted during npm install)
227
+
npm install -g @stackmemoryai/stackmemory
228
+
229
+
# Manual install
230
+
stackmemory hooks install
135
231
136
-
See above for install and minimal usage. For advanced options, see Setup.
Hooks are stored in `~/.claude/hooks/` and configured via `~/.claude/hooks.json`.
237
+
238
+
### PROMPT_PLAN Auto-Progress
239
+
240
+
When a task completes (via hook or `/linear-run`), StackMemory fuzzy-matches the task title against unchecked `- [ ]` items in `docs/specs/PROMPT_PLAN.md` and checks them off automatically. One item per task completion, best-effort.
137
241
138
242
---
139
243
140
-
## 2. Detailed Setup
244
+
## Prompt Forge (GEPA)
245
+
246
+
When launching via `claude-sm`, StackMemory watches `CLAUDE.md`, `AGENT.md`, and `AGENTS.md` for changes. On file modification, the GEPA optimizer analyzes content and suggests improvements for prompt clarity and structure. Runs as a detached background process.
247
+
248
+
```bash
249
+
# Launch with Prompt Forge active
250
+
claude-sm
251
+
252
+
# Status shown in terminal:
253
+
# Prompt Forge: watching CLAUDE.md, AGENTS.md for optimization
254
+
```
255
+
256
+
---
141
257
142
258
### Install
143
259
@@ -180,15 +296,11 @@ stackmemory doctor
180
296
181
297
Checks project initialization, database integrity, MCP config, and suggests fixes.
182
298
183
-
---
184
-
185
-
## 3. Advanced Setup
186
-
187
-
See https://github.com/stackmemoryai/stackmemory/blob/main/docs/setup.md for advanced options (hosted mode, ChromaDB, manual MCP config, and available tools).
299
+
See [docs/setup.md](https://github.com/stackmemoryai/stackmemory/blob/main/docs/setup.md) for advanced options (hosted mode, ChromaDB, manual MCP config).
StackMemory can automatically save context when using Claude Code, so your AI assistant has access to previous context and decisions.
289
-
290
-
### Quick Setup
400
+
StackMemory integrates with Claude Code via MCP tools, skills, and hooks. See the [Hooks](#hooks-automatic) and [Skills](#skills-system) sections above.
Copy file name to clipboardExpand all lines: package.json
+9-4Lines changed: 9 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
{
2
2
"name": "@stackmemoryai/stackmemory",
3
3
"version": "0.5.67",
4
-
"description": "Project-scoped memory for AI coding tools. Durable context across sessions with MCP integration, frames, and smart retrieval.",
4
+
"description": "Project-scoped memory for AI coding tools. Durable context across sessions with MCP integration, frames, smart retrieval, Claude Code skills, and automatic hooks.",
0 commit comments