Skip to content

Commit ca78bf0

Browse files
Claudeclaude
authored andcommitted
docs: update README with multi-client support
- Updated hero line to list VS Code and Windsurf - Quick Start now shows auto-detection and --client flag - Supported Clients table expanded with hooks column - Added manual config paths table for all clients - CLI Commands table includes --client option Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 51952dd commit ca78bf0

File tree

1 file changed

+30
-16
lines changed

1 file changed

+30
-16
lines changed

README.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,27 @@
2121

2222
GitMem is an [MCP server](https://modelcontextprotocol.io/) that gives your AI coding agent **persistent memory across sessions**. It remembers mistakes (scars), successes (wins), and decisions — so your agent learns from experience instead of starting from scratch every time.
2323

24-
Works with **Claude Code**, **Claude Desktop**, **Cursor**, and any MCP-compatible client.
24+
Works with **Claude Code**, **Cursor**, **VS Code (Copilot)**, **Windsurf**, and any MCP-compatible client.
2525

2626
## Quick Start
2727

2828
```bash
2929
npx gitmem-mcp init
3030
```
3131

32-
One command. The wizard sets up everything:
33-
- `.gitmem/` directory with 3 starter scars
34-
- `.mcp.json` with gitmem server entry
35-
- `CLAUDE.md` with memory protocol instructions
36-
- `.claude/settings.json` with tool permissions
37-
- Lifecycle hooks for automatic session management
32+
One command. The wizard auto-detects your IDE and sets up everything:
33+
- `.gitmem/` directory with starter scars
34+
- MCP server config (`.mcp.json`, `.vscode/mcp.json`, `.cursor/mcp.json`, etc.)
35+
- Instructions file (`CLAUDE.md`, `.cursorrules`, `.windsurfrules`, `.github/copilot-instructions.md`)
36+
- Lifecycle hooks (where supported)
3837
- `.gitignore` updated
3938

4039
Already have existing config? The wizard merges without destroying anything. Re-running is safe.
4140

4241
```bash
43-
npx gitmem-mcp init --yes # Non-interactive
44-
npx gitmem-mcp init --dry-run # Preview changes
42+
npx gitmem-mcp init --yes # Non-interactive
43+
npx gitmem-mcp init --dry-run # Preview changes
44+
npx gitmem-mcp init --client vscode # Force specific client
4545
```
4646

4747
## How It Works
@@ -78,16 +78,22 @@ Every scar includes **counter-arguments** — reasons why someone might reasonab
7878

7979
## Supported Clients
8080

81-
| Client | Setup |
82-
|--------|-------|
83-
| **Claude Code** | `npx gitmem-mcp init` (auto-detected) |
84-
| **Claude Desktop** | `npx gitmem-mcp init` or add to `claude_desktop_config.json` |
85-
| **Cursor** | `npx gitmem-mcp init` or add to `.cursor/mcp.json` |
86-
| **Any MCP client** | Add `npx -y gitmem-mcp` as an MCP server |
81+
| Client | Setup | Hooks |
82+
|--------|-------|-------|
83+
| **Claude Code** | `npx gitmem-mcp init` | Full (session, recall, credential guard) |
84+
| **Cursor** | `npx gitmem-mcp init --client cursor` | Partial (session, recall) |
85+
| **VS Code (Copilot)** | `npx gitmem-mcp init --client vscode` | Instructions-based |
86+
| **Windsurf** | `npx gitmem-mcp init --client windsurf` | Instructions-based |
87+
| **Claude Desktop** | Add to `claude_desktop_config.json` | Manual |
88+
| **Any MCP client** | `npx gitmem-mcp init --client generic` | Instructions-based |
89+
90+
The wizard auto-detects your IDE. Use `--client` to override.
8791

8892
<details>
8993
<summary><strong>Manual MCP configuration</strong></summary>
9094

95+
Add this to your MCP client's config file:
96+
9197
```json
9298
{
9399
"mcpServers": {
@@ -99,13 +105,21 @@ Every scar includes **counter-arguments** — reasons why someone might reasonab
99105
}
100106
```
101107

108+
| Client | Config file |
109+
|--------|-------------|
110+
| Claude Code | `.mcp.json` |
111+
| Cursor | `.cursor/mcp.json` |
112+
| VS Code | `.vscode/mcp.json` |
113+
| Windsurf | `~/.codeium/windsurf/mcp_config.json` |
114+
102115
</details>
103116

104117
## CLI Commands
105118

106119
| Command | Description |
107120
|---------|-------------|
108-
| `npx gitmem-mcp init` | Interactive setup wizard |
121+
| `npx gitmem-mcp init` | Interactive setup wizard (auto-detects IDE) |
122+
| `npx gitmem-mcp init --client <name>` | Setup for specific client (`claude`, `cursor`, `vscode`, `windsurf`, `generic`) |
109123
| `npx gitmem-mcp init --yes` | Non-interactive setup |
110124
| `npx gitmem-mcp init --dry-run` | Preview changes |
111125
| `npx gitmem-mcp uninstall` | Clean removal (preserves `.gitmem/` data) |

0 commit comments

Comments
 (0)