Skip to content

Commit 45ef4de

Browse files
Claudeclaude
authored andcommitted
fix: correct package name in docs — npx gitmem-mcp init, not npx gitmem init
The npm package is gitmem-mcp (not gitmem). All npx commands in docs referenced the wrong package name, which would fail for users. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent bff6191 commit 45ef4de

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

apps/docs/content/docs/changelog.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ description: GitMem release history.
99

1010
### Features
1111

12-
- **`npx gitmem init`** — Interactive setup wizard that detects existing config, prompts, and merges without destroying anything. Replaces the multi-step manual setup.
12+
- **`npx gitmem-mcp init`** — Interactive setup wizard that detects existing config, prompts, and merges without destroying anything. Replaces the multi-step manual setup.
1313
- 6 steps: memory store, MCP server, CLAUDE.md, permissions, hooks, gitignore
1414
- Flags: `--yes` (non-interactive), `--dry-run` (preview), `--project <name>`
1515
- Idempotent — re-running safely skips completed steps
16-
- **`npx gitmem uninstall`** — Clean reversal of everything init did. Memory data (`.gitmem/`) preserved by default, `--all` to also delete.
16+
- **`npx gitmem-mcp uninstall`** — Clean reversal of everything init did. Memory data (`.gitmem/`) preserved by default, `--all` to also delete.
1717

1818
### Docs
1919

apps/docs/content/docs/getting-started/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ GitMem gives your AI coding agents institutional memory — the ability to learn
99

1010
## Prerequisites
1111

12-
- **Node.js 18+** (for `npx gitmem init`)
12+
- **Node.js 18+** (for `npx gitmem-mcp init`)
1313
- An MCP-compatible client: [Claude Code](https://claude.com/claude-code), [Claude Desktop](https://claude.ai/download), or [Cursor](https://cursor.sh)
1414

1515
## Quick Start (30 seconds)
1616

1717
```bash
1818
# In any project directory
19-
npx gitmem init
19+
npx gitmem-mcp init
2020
```
2121

2222
The interactive wizard detects your existing config and sets up everything:

apps/docs/content/docs/getting-started/installation.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The recommended way to install GitMem. One command, interactive setup, safe to r
2020

2121
```bash
2222
cd your-project
23-
npx gitmem init
23+
npx gitmem-mcp init
2424
```
2525

2626
<Steps>
@@ -54,17 +54,17 @@ Adds `.gitmem/` to `.gitignore` — memory data stays local.
5454

5555
```bash
5656
# Accept all defaults (non-interactive)
57-
npx gitmem init --yes
57+
npx gitmem-mcp init --yes
5858

5959
# Preview what would change (no files written)
60-
npx gitmem init --dry-run
60+
npx gitmem-mcp init --dry-run
6161

6262
# Set a project namespace
63-
npx gitmem init --project my-app
63+
npx gitmem-mcp init --project my-app
6464
```
6565

6666
<Callout type="info" title="Idempotent">
67-
Re-running `npx gitmem init` is safe — completed steps are skipped with "Already configured."
67+
Re-running `npx gitmem-mcp init` is safe — completed steps are skipped with "Already configured."
6868
</Callout>
6969

7070
### What Gets Created
@@ -89,14 +89,14 @@ Re-running `npx gitmem init` is safe — completed steps are skipped with "Alrea
8989
### Uninstall
9090

9191
```bash
92-
npx gitmem uninstall
92+
npx gitmem-mcp uninstall
9393
```
9494

9595
Cleanly reverses everything init did. Your `.gitmem/` data is preserved by default.
9696

9797
```bash
9898
# Also delete .gitmem/ memory data
99-
npx gitmem uninstall --all
99+
npx gitmem-mcp uninstall --all
100100
```
101101

102102
</Tab>
@@ -206,14 +206,14 @@ See [Configuration](/docs/getting-started/configuration) for full details.
206206
## Troubleshooting
207207

208208
<Accordions type="single">
209-
<Accordion title="npx gitmem init hangs or fails">
210-
Ensure Node.js 18+ is installed (`node --version`). If behind a corporate proxy, try `npm install -g gitmem-mcp` first, then use `gitmem init` without npx.
209+
<Accordion title="npx gitmem-mcp init hangs or fails">
210+
Ensure Node.js 18+ is installed (`node --version`). If behind a corporate proxy, try `npm install -g gitmem-mcp` first, then use `gitmem-mcp init` without npx.
211211
</Accordion>
212212
<Accordion title="Agent can't find gitmem tools">
213213
Check that `.mcp.json` exists in your project root and contains the gitmem server entry. For Claude Desktop, verify the config path matches your OS. Restart the client after config changes.
214214
</Accordion>
215215
<Accordion title="Permission errors on tool calls">
216-
Run `npx gitmem init` to add tool permissions to `.claude/settings.json`, or manually add `mcp__gitmem__*` to the `allow` array.
216+
Run `npx gitmem-mcp init` to add tool permissions to `.claude/settings.json`, or manually add `mcp__gitmem__*` to the `allow` array.
217217
</Accordion>
218218
<Accordion title="Starter scars show wrong age">
219219
Starter scars use fixed creation dates. This is cosmetic — the scars function correctly regardless of displayed age.

apps/docs/content/docs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Every time an AI agent makes a mistake, fixes a bug, or discovers a better appro
6464
<div className="install-block">
6565

6666
```bash
67-
npx gitmem init
67+
npx gitmem-mcp init
6868
```
6969

7070
One command sets up everything: `.gitmem/` directory, `.mcp.json`, `CLAUDE.md`, hooks, and permissions. Already have existing config? The wizard merges without destroying anything.

0 commit comments

Comments
 (0)