Skip to content

Commit 28803b0

Browse files
author
StackMemory Bot (CLI)
committed
docs(site): add OG tags, comparison, tools reference, changelog, getting started
- Open Graph + Twitter Card meta tags with OG image for social previews - Terminal demo SVG in README hero and landing page - Comparison page (StackMemory vs CLAUDE.md vs .cursorrules vs vanilla) - MCP tools reference page (all 32 tools across 8 categories) - Changelog page with full release history - Getting Started guide (docs/GETTING_STARTED.md) - npm keywords expanded (17 → 30), homepage updated to GitHub Pages - Landing page nav links to new pages
1 parent bcc926c commit 28803b0

File tree

10 files changed

+961
-10
lines changed

10 files changed

+961
-10
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@
55
[![Coverage](https://codecov.io/gh/stackmemoryai/stackmemory/branch/main/graph/badge.svg)](https://codecov.io/gh/stackmemoryai/stackmemory)
66
[![npm version](https://img.shields.io/npm/v/@stackmemoryai/stackmemory)](https://www.npmjs.com/package/@stackmemoryai/stackmemory)
77

8-
Lossless, project-scoped memory for AI coding tools.
8+
Lossless, project-scoped memory for AI coding tools. **[Website](https://stackmemoryai.github.io/stackmemory/)** | **[MCP Tools](https://stackmemoryai.github.io/stackmemory/tools.html)** | **[Getting Started](./docs/GETTING_STARTED.md)**
9+
10+
<p align="center">
11+
<img src="site/demo.svg" alt="StackMemory setup demo" width="560">
12+
</p>
913

1014
StackMemory is a **production-ready memory runtime** for AI coding tools that preserves full project context across sessions:
1115

@@ -351,6 +355,8 @@ See [docs/cli.md](https://github.com/stackmemoryai/stackmemory/blob/main/docs/cl
351355

352356
## Documentation
353357

358+
- [Getting Started](./docs/GETTING_STARTED.md) — Quick start guide (5 minutes)
359+
- [MCP Tools Reference](https://stackmemoryai.github.io/stackmemory/tools.html) — All 32 MCP tools
354360
- [CLI Reference](./docs/cli.md) — Full command reference
355361
- [Setup Guide](./docs/SETUP.md) — Advanced setup options
356362
- [Development Guide](./docs/DEVELOPMENT.md) — Contributing and development

docs/GETTING_STARTED.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# Getting Started with StackMemory
2+
3+
This guide walks you from zero to a fully working StackMemory setup in under 5 minutes.
4+
5+
## Prerequisites
6+
7+
- **Node.js 20+** (`node --version` to check)
8+
- **Claude Code**, **Codex**, or **OpenCode** installed
9+
- macOS, Linux, or WSL
10+
11+
## Step 1: Install
12+
13+
```bash
14+
npm install -g @stackmemoryai/stackmemory
15+
```
16+
17+
This installs the `stackmemory` CLI and wrapper scripts (`claude-sm`, `codex-sm`, `opencode-sm`).
18+
19+
## Step 2: Initialize your project
20+
21+
```bash
22+
cd your-project
23+
stackmemory init
24+
```
25+
26+
This creates a `.stackmemory/` directory with:
27+
- SQLite database for context storage
28+
- FTS5 full-text search index
29+
- Default configuration
30+
31+
Add `.stackmemory/` to your `.gitignore` — it's local state, not shared.
32+
33+
## Step 3: Connect to your editor
34+
35+
```bash
36+
stackmemory setup-mcp
37+
```
38+
39+
This configures Claude Code's MCP settings to connect to StackMemory. After running this, **restart Claude Code**.
40+
41+
## Step 4: Verify
42+
43+
```bash
44+
stackmemory doctor
45+
```
46+
47+
You should see all green checkmarks. If anything fails, the doctor output will tell you what to fix.
48+
49+
## Your first session
50+
51+
### Using wrapper scripts (recommended)
52+
53+
```bash
54+
claude-sm # Claude Code with StackMemory context auto-loaded
55+
```
56+
57+
The wrapper script:
58+
1. Loads your existing StackMemory context into the session
59+
2. Starts the Prompt Forge optimizer (watches CLAUDE.md for improvements)
60+
3. Runs Claude Code normally
61+
62+
### Using MCP tools directly
63+
64+
In Claude Code, StackMemory tools are available immediately:
65+
66+
```
67+
> Use get_context to see what I was working on last session
68+
69+
> Use add_decision to record: "Using PostgreSQL for the user service"
70+
71+
> Use start_frame to begin work on "Implement auth middleware"
72+
```
73+
74+
## How context survives sessions
75+
76+
1. During your session, StackMemory records events, decisions, and anchors
77+
2. When you run `/clear` or close the session, hooks automatically save context
78+
3. Next session, `get_context` retrieves everything — decisions, constraints, progress
79+
4. You never re-explain context to your AI coding tool again
80+
81+
## Key commands
82+
83+
| Command | What it does |
84+
|---------|-------------|
85+
| `stackmemory init` | Initialize StackMemory in a project |
86+
| `stackmemory setup-mcp` | Configure Claude Code MCP connection |
87+
| `stackmemory doctor` | Verify installation health |
88+
| `stackmemory capture` | Save current session state |
89+
| `stackmemory restore` | Restore from a captured state |
90+
| `stackmemory daemon start` | Start the memory monitor daemon |
91+
| `stackmemory hooks install` | Install Claude Code hooks |
92+
93+
## Key MCP tools
94+
95+
| Tool | What it does |
96+
|------|-------------|
97+
| `get_context` | Retrieve project context and active frame |
98+
| `add_decision` | Record a decision or constraint |
99+
| `start_frame` | Begin a new scoped unit of work |
100+
| `close_frame` | Complete and summarize current work |
101+
| `sm_search` | Search across all context |
102+
| `cord_spawn` | Create a subtask with clean context |
103+
104+
## Optional: Linear integration
105+
106+
```bash
107+
# Set your Linear API key
108+
echo "LINEAR_API_KEY=lin_api_..." >> .env
109+
110+
# Sync tasks
111+
stackmemory linear:sync
112+
```
113+
114+
Tasks flow bidirectionally between Linear and your coding sessions.
115+
116+
## Optional: Hooks
117+
118+
StackMemory can install Claude Code hooks that run automatically:
119+
120+
```bash
121+
stackmemory hooks install
122+
```
123+
124+
Hooks handle:
125+
- Auto-saving context on `/clear`
126+
- Task completion tracking
127+
- Linear sync on task done
128+
- PROMPT_PLAN progress updates
129+
130+
## Next steps
131+
132+
- Read the [CLI Reference](./cli.md) for all commands
133+
- Explore the [Architecture](./architecture.md) to understand the call stack model
134+
- Check the [MCP Tools Reference](./MCP_TOOLS.md) for all 32 tools

package.json

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
"type": "git",
5353
"url": "https://github.com/stackmemoryai/stackmemory.git"
5454
},
55-
"homepage": "https://github.com/stackmemoryai/stackmemory",
55+
"homepage": "https://stackmemoryai.github.io/stackmemory/",
5656
"bugs": {
5757
"url": "https://github.com/stackmemoryai/stackmemory/issues"
5858
},
@@ -63,22 +63,35 @@
6363
},
6464
"keywords": [
6565
"ai",
66+
"ai-memory",
67+
"ai-coding",
6668
"memory",
6769
"context",
70+
"context-management",
6871
"llm",
6972
"mcp",
73+
"mcp-server",
74+
"mcp-tools",
75+
"model-context-protocol",
7076
"claude",
7177
"claude-code",
72-
"coding",
78+
"codex",
79+
"opencode",
80+
"coding-assistant",
7381
"persistence",
82+
"session-persistence",
83+
"fts5",
84+
"full-text-search",
85+
"sqlite",
7486
"skills",
7587
"hooks",
76-
"spec-generator",
7788
"linear",
89+
"linear-integration",
7890
"task-runner",
79-
"prompt-optimization",
80-
"model-routing",
81-
"agent-orchestration"
91+
"agent-orchestration",
92+
"multi-agent",
93+
"developer-tools",
94+
"devtools"
8295
],
8396
"scripts": {
8497
"start": "node dist/src/integrations/mcp/server.js",

0 commit comments

Comments
 (0)