Skip to content

docs: simplify README by removing Quick Start and integration sections #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TonyCasey merged 1 commit into from
Feb 14, 2026
+1 −144
Merged

docs: simplify README by removing Quick Start and integration sections #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 1 addition & 144 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# git-mem
# Git Mem

Your git history is the perfect context for AI.
It just needs to be extracted for agents....
Expand Down Expand Up @@ -34,149 +34,6 @@ git-mem init

`init` sets up hooks, MCP config, .gitignore entries, and runs an initial extract from your history.

## Quick Start

### Store a memory

```bash
git-mem remember "Use JWT for auth — decided in sprint 3" --type decision --tags auth,security
```

### Recall memories

```bash
git-mem recall --query "authentication"
```

### Scan git history for knowledge

```bash
git-mem extract --since 2026-01-01
```

### Surface context for staged changes

```bash
git-mem context
```

## Claude Code Integration

git-mem integrates with [Claude Code](https://docs.anthropic.com/en/docs/claude-code) via lifecycle hooks to give Claude persistent project memory across sessions.

### How It Works

```text
Claude Code starts session
→ git-mem hook session-start
→ Loads stored memories into Claude's context

User submits prompt (optional)
→ git-mem hook prompt-submit
→ Surfaces relevant memories for the prompt

Claude Code session ends
→ git-mem hook session-stop
→ Scans commits made during session, extracts new memories
```

### Hooks

| Hook | Event | What it does |
|------|-------|-------------|
| `session-start` | `SessionStart` | Loads stored memories as markdown context |
| `session-stop` | `SessionStop` | Captures memories from recent commits via `extract` |
| `prompt-submit` | `UserPromptSubmit` | Surfaces relevant memories per prompt (disabled by default) |

### Configuration

Edit `.git-mem.json` to customize hook behavior:

```json
{
"hooks": {
"enabled": true,
"sessionStart": {
"enabled": true,
"memoryLimit": 20
},
"sessionStop": {
"enabled": true,
"autoExtract": true,
"threshold": 3
},
"promptSubmit": {
"enabled": false,
"recordPrompts": false,
"surfaceContext": true
}
}
}
```

| Option | Default | Description |
|--------|---------|-------------|
| `hooks.enabled` | `true` | Master switch for all hooks |
| `sessionStart.enabled` | `true` | Load memories on session start |
| `sessionStart.memoryLimit` | `20` | Max memories to load |
| `sessionStop.enabled` | `true` | Capture memories on session end |
| `sessionStop.autoExtract` | `true` | Auto-scan commits for memories |
| `sessionStop.threshold` | `3` | Minimum commit triage score |
| `promptSubmit.enabled` | `false` | Surface context per prompt |
| `promptSubmit.surfaceContext` | `true` | Include memories in prompt context |

## MCP Server

git-mem also ships as an MCP server for tools that support the Model Context Protocol:

```bash
git-mem init # includes MCP setup
```

This registers `git-mem-mcp` with 4 tools: `remember`, `recall`, `context`, `extract`.

## Architecture

```text
┌─────────────────────────────────────────────┐
│ Entry Points │
│ ┌─────┐ ┌─────────┐ ┌────────────────┐ │
│ │ CLI │ │ MCP Srv │ │ Claude Hooks │ │
│ └──┬──┘ └────┬────┘ └───────┬────────┘ │
│ │ │ │ │
│ └──────────┴───────┬───────┘ │
│ │ │
│ ┌─────────┴─────────┐ │
│ │ DI Container │ │
│ │ (awilix) │ │
│ └─────────┬─────────┘ │
│ │ │
│ ┌─────────────────────┴──────────────────┐ │
│ │ Application Layer │ │
│ │ MemoryService ExtractService │ │
│ │ ContextService SessionCaptureService │ │
│ │ SessionStartHandler PromptSubmitHandler│ │
│ └─────────────────────┬──────────────────┘ │
│ │ │
│ ┌─────────────────────┴──────────────────┐ │
│ │ Domain Layer │ │
│ │ IMemoryEntity IMemoryRepository │ │
│ │ IEventBus HookEvents IHookConfig │ │
│ └────────────────────────────────────────┘ │
│ │ │
│ ┌─────────────────────┴──────────────────┐ │
│ │ Infrastructure Layer │ │
│ │ GitClient NotesService EventBus │ │
│ │ MemoryRepository HeuristicPatterns │ │
│ └────────────────────────────────────────┘ │
│ │ │
│ ┌─────────┴─────────┐ │
│ │ Git Notes │ │
│ │ refs/notes/mem │ │
│ └───────────────────┘ │
└─────────────────────────────────────────────┘
```

See the [Getting Started Guide](./docs/getting-started.md) for full CLI and MCP setup docs.

## License
Expand Down