From d160df4b8689e8adc2e399244980f85a279ed06a Mon Sep 17 00:00:00 2001 From: Alex Newman Date: Mon, 29 Dec 2025 22:15:47 -0500 Subject: [PATCH] refactor(cursor): Migrate setup commands from npm to Bun for improved performance - Updated installation and setup commands in documentation to use Bun instead of npm. - Adjusted commands across various setup guides including QUICKSTART.md, STANDALONE-SETUP.md, and others. - Ensured consistency in command usage for all platforms (macOS, Linux, Windows). This change enhances the installation process and aligns with the recent performance improvements associated with Bun. --- cursor-hooks/QUICKSTART.md | 2 +- cursor-hooks/README.md | 4 +-- cursor-hooks/STANDALONE-SETUP.md | 38 ++++++++++++------------- docs/public/cursor/gemini-setup.mdx | 16 +++++------ docs/public/cursor/index.mdx | 36 +++++++++++------------ docs/public/cursor/openrouter-setup.mdx | 16 +++++------ 6 files changed, 56 insertions(+), 56 deletions(-) diff --git a/cursor-hooks/QUICKSTART.md b/cursor-hooks/QUICKSTART.md index b2573e60..f0cf769a 100644 --- a/cursor-hooks/QUICKSTART.md +++ b/cursor-hooks/QUICKSTART.md @@ -97,7 +97,7 @@ Restart Cursor to load the hooks. **Worker not responding?** - Check if worker is running: `curl http://127.0.0.1:37777/api/readiness` - Check logs: `tail -f ~/.claude-mem/logs/worker-$(date +%Y-%m-%d).log` -- Restart worker: `npm run worker:restart` +- Restart worker: `bun run worker:restart` **Observations not saving?** - Check worker logs for errors diff --git a/cursor-hooks/README.md b/cursor-hooks/README.md index 581f0953..95aa954d 100644 --- a/cursor-hooks/README.md +++ b/cursor-hooks/README.md @@ -16,10 +16,10 @@ Give your Cursor AI persistent memory across sessions. Your agent remembers what ```bash # Clone and build git clone https://github.com/thedotmack/claude-mem.git -cd claude-mem && npm install && npm run build +cd claude-mem && bun install && bun run build # Interactive setup (configures provider + installs hooks) -npm run cursor:setup +bun run cursor:setup ``` --- diff --git a/cursor-hooks/STANDALONE-SETUP.md b/cursor-hooks/STANDALONE-SETUP.md index 50a79e52..5a3e7c23 100644 --- a/cursor-hooks/STANDALONE-SETUP.md +++ b/cursor-hooks/STANDALONE-SETUP.md @@ -18,7 +18,7 @@ Use claude-mem's persistent memory in Cursor without a Claude Code subscription. ### macOS / Linux - Cursor IDE -- Node.js 18+ +- [Bun](https://bun.sh) (`curl -fsSL https://bun.sh/install | bash`) - Git - `jq` and `curl`: - **macOS**: `brew install jq curl` @@ -26,7 +26,7 @@ Use claude-mem's persistent memory in Cursor without a Claude Code subscription. ### Windows - Cursor IDE -- Node.js 18+ +- [Bun](https://bun.sh) (PowerShell: `powershell -c "irm bun.sh/install.ps1 | iex"`) - Git - PowerShell 5.1+ (included with Windows 10/11) @@ -38,10 +38,10 @@ git clone https://github.com/thedotmack/claude-mem.git cd claude-mem # Install dependencies -npm install +bun install # Build the project -npm run build +bun run build ``` ## Step 2: Configure Provider (Choose One) @@ -107,10 +107,10 @@ EOF ```bash # From the claude-mem repo directory -npm run cursor:install +bun run cursor:install # Or for user-level (all projects): -npm run cursor:install -- user +bun run cursor:install -- user ``` This installs: @@ -121,7 +121,7 @@ This installs: ## Step 4: Start the Worker ```bash -npm run worker:start +bun run worker:start ``` The worker runs in the background and handles: @@ -136,7 +136,7 @@ The worker runs in the background and handles: 2. **Check installation status**: ```bash - npm run cursor:status + bun run cursor:status ``` 3. **Verify the worker is running**: @@ -196,12 +196,12 @@ If you hit the 1500 requests/day limit: | Command | Purpose | |---------|---------| -| `npm run cursor:install` | Install hooks for current project | -| `npm run cursor:install -- user` | Install hooks for all projects | -| `npm run cursor:status` | Check installation status | -| `npm run worker:start` | Start the background worker | -| `npm run worker:stop` | Stop the background worker | -| `npm run worker:restart` | Restart the worker | +| `bun run cursor:install` | Install hooks for current project | +| `bun run cursor:install -- user` | Install hooks for all projects | +| `bun run cursor:status` | Check installation status | +| `bun run worker:start` | Start the background worker | +| `bun run worker:stop` | Stop the background worker | +| `bun run worker:restart` | Restart the worker | --- @@ -223,8 +223,8 @@ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser # Clone and build git clone https://github.com/thedotmack/claude-mem.git cd claude-mem -npm install -npm run build +bun install +bun run build # Configure provider (Gemini example) $settingsDir = "$env:USERPROFILE\.claude-mem" @@ -238,11 +238,11 @@ New-Item -ItemType Directory -Force -Path $settingsDir "@ | Out-File -FilePath "$settingsDir\settings.json" -Encoding UTF8 # Interactive setup (recommended - walks you through everything) -npm run cursor:setup +bun run cursor:setup # Or manual installation -npm run cursor:install -npm run worker:start +bun run cursor:install +bun run worker:start ``` ### What Gets Installed on Windows diff --git a/docs/public/cursor/gemini-setup.mdx b/docs/public/cursor/gemini-setup.mdx index 5f756c00..695ef781 100644 --- a/docs/public/cursor/gemini-setup.mdx +++ b/docs/public/cursor/gemini-setup.mdx @@ -32,10 +32,10 @@ git clone https://github.com/thedotmack/claude-mem.git cd claude-mem # Install dependencies -npm install +bun install # Build the project -npm run build +bun run build ``` ## Step 3: Configure Gemini Provider @@ -45,7 +45,7 @@ npm run build Run the setup wizard which guides you through everything: ```bash -npm run cursor:setup +bun run cursor:setup ``` The wizard will: @@ -77,8 +77,8 @@ Replace `YOUR_GEMINI_API_KEY` with your actual API key. Then install hooks and start the worker: ```bash -npm run cursor:install -npm run worker:start +bun run cursor:install +bun run worker:start ``` ## Step 4: Restart Cursor @@ -89,10 +89,10 @@ Close and reopen Cursor IDE for the hooks to take effect. ```bash # Check worker is running -npm run worker:status +bun run worker:status # Check hooks are installed -npm run cursor:status +bun run cursor:status ``` Open http://localhost:37777 to see the memory viewer. @@ -169,7 +169,7 @@ You're exceeding the free tier limits. Options: Check the worker logs: ```bash -npm run worker:logs +bun run worker:logs ``` Look for error messages related to Gemini API calls. diff --git a/docs/public/cursor/index.mdx b/docs/public/cursor/index.mdx index 96f529cc..2970a97c 100644 --- a/docs/public/cursor/index.mdx +++ b/docs/public/cursor/index.mdx @@ -48,10 +48,10 @@ If you're using Cursor without a Claude Code subscription: ```bash # Clone and build git clone https://github.com/thedotmack/claude-mem.git -cd claude-mem && npm install && npm run build +cd claude-mem && bun install && bun run build # Run interactive setup wizard -npm run cursor:setup +bun run cursor:setup ``` The setup wizard will: @@ -83,17 +83,17 @@ The plugin uses Claude's SDK by default but you can switch to Gemini or OpenRout - - Node.js 18+ + - [Bun](https://bun.sh): `curl -fsSL https://bun.sh/install | bash` - Cursor IDE - jq and curl: `brew install jq curl` - - Node.js 18+ + - [Bun](https://bun.sh): `curl -fsSL https://bun.sh/install | bash` - Cursor IDE - jq and curl: `apt install jq curl` or `dnf install jq curl` - - Node.js 18+ + - [Bun](https://bun.sh): `powershell -c "irm bun.sh/install.ps1 | iex"` - Cursor IDE - PowerShell 5.1+ (included in Windows 10/11) - Git for Windows @@ -106,13 +106,13 @@ After installation, these commands are available from the claude-mem directory: | Command | Description | |---------|-------------| -| `npm run cursor:setup` | Interactive setup wizard | -| `npm run cursor:install` | Install Cursor hooks | -| `npm run cursor:uninstall` | Remove Cursor hooks | -| `npm run cursor:status` | Check hook installation status | -| `npm run worker:start` | Start the worker service | -| `npm run worker:stop` | Stop the worker service | -| `npm run worker:status` | Check worker status | +| `bun run cursor:setup` | Interactive setup wizard | +| `bun run cursor:install` | Install Cursor hooks | +| `bun run cursor:uninstall` | Remove Cursor hooks | +| `bun run cursor:status` | Check hook installation status | +| `bun run worker:start` | Start the worker service | +| `bun run worker:stop` | Stop the worker service | +| `bun run worker:status` | Check worker status | ## Verifying Installation @@ -120,12 +120,12 @@ After setup, verify everything is working: 1. **Check worker status:** ```bash - npm run worker:status + bun run worker:status ``` 2. **Check hook installation:** ```bash - npm run cursor:status + bun run cursor:status ``` 3. **Open the memory viewer:** @@ -154,21 +154,21 @@ After setup, verify everything is working: lsof -i :37777 # Force restart -npm run worker:stop && npm run worker:start +bun run worker:stop && bun run worker:start # Check logs -npm run worker:logs +bun run worker:logs ``` ### Hooks not firing 1. Restart Cursor IDE after installation -2. Check hooks are installed: `npm run cursor:status` +2. Check hooks are installed: `bun run cursor:status` 3. Verify hooks.json exists in `.cursor/` directory ### No context appearing -1. Ensure worker is running: `npm run worker:status` +1. Ensure worker is running: `bun run worker:status` 2. Check that you have observations: visit http://localhost:37777 3. Verify your API key is configured correctly diff --git a/docs/public/cursor/openrouter-setup.mdx b/docs/public/cursor/openrouter-setup.mdx index a7141d1a..a90d0a4d 100644 --- a/docs/public/cursor/openrouter-setup.mdx +++ b/docs/public/cursor/openrouter-setup.mdx @@ -31,10 +31,10 @@ git clone https://github.com/thedotmack/claude-mem.git cd claude-mem # Install dependencies -npm install +bun install # Build the project -npm run build +bun run build ``` ## Step 3: Configure OpenRouter Provider @@ -44,7 +44,7 @@ npm run build Run the setup wizard which guides you through everything: ```bash -npm run cursor:setup +bun run cursor:setup ``` When prompted for provider, select **OpenRouter**. @@ -71,8 +71,8 @@ Replace `YOUR_OPENROUTER_API_KEY` with your actual API key. Then install hooks and start the worker: ```bash -npm run cursor:install -npm run worker:start +bun run cursor:install +bun run worker:start ``` ## Step 4: Restart Cursor @@ -83,10 +83,10 @@ Close and reopen Cursor IDE for the hooks to take effect. ```bash # Check worker is running -npm run worker:status +bun run worker:status # Check hooks are installed -npm run cursor:status +bun run cursor:status ``` Open http://localhost:37777 to see the memory viewer. @@ -166,7 +166,7 @@ OpenRouter rate limits vary by model and your account tier. If you hit limits: Check the worker logs for details: ```bash -npm run worker:logs +bun run worker:logs ``` Common issues: