airkjw/claude-mem
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(cursor): Migrate setup commands from npm to Bun for improved performance

Browse Source 
- 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.
This commit is contained in:
Alex Newman
2025-12-29 22:15:47 -05:00
parent b5e45377b0
commit d160df4b86
6 changed files with 56 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cursor-hooks/QUICKSTART.md
+1 -1
View File
@@ -97,7 +97,7 @@ Restart Cursor to load the hooks.
**Worker not responding?** **Worker not responding?**
- Check if worker is running: `curl http://127.0.0.1:37777/api/readiness` - 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` - 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?** **Observations not saving?**
- Check worker logs for errors - Check worker logs for errors
cursor-hooks/README.md
+2 -2
View File
@@ -16,10 +16,10 @@ Give your Cursor AI persistent memory across sessions. Your agent remembers what
```bash ```bash
# Clone and build # Clone and build
git clone https://github.com/thedotmack/claude-mem.git 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) # Interactive setup (configures provider + installs hooks)
npm run cursor:setup bun run cursor:setup
``` ```
--- ---
cursor-hooks/STANDALONE-SETUP.md
+19 -19
View File
@@ -18,7 +18,7 @@ Use claude-mem's persistent memory in Cursor without a Claude Code subscription.
### macOS / Linux ### macOS / Linux
- Cursor IDE - Cursor IDE
- Node.js 18+ - [Bun](https://bun.sh) (`curl -fsSL https://bun.sh/install | bash`)
- Git - Git
- `jq` and `curl`: - `jq` and `curl`:
- **macOS**: `brew install jq curl` - **macOS**: `brew install jq curl`
@@ -26,7 +26,7 @@ Use claude-mem's persistent memory in Cursor without a Claude Code subscription.
### Windows ### Windows
- Cursor IDE - Cursor IDE
- Node.js 18+ - [Bun](https://bun.sh) (PowerShell: `powershell -c "irm bun.sh/install.ps1 | iex"`)
- Git - Git
- PowerShell 5.1+ (included with Windows 10/11) - PowerShell 5.1+ (included with Windows 10/11)
@@ -38,10 +38,10 @@ git clone https://github.com/thedotmack/claude-mem.git
cd claude-mem cd claude-mem
# Install dependencies # Install dependencies
npm install bun install
# Build the project # Build the project
npm run build bun run build
``` ```
## Step 2: Configure Provider (Choose One) ## Step 2: Configure Provider (Choose One)
@@ -107,10 +107,10 @@ EOF
```bash ```bash
# From the claude-mem repo directory # From the claude-mem repo directory
npm run cursor:install bun run cursor:install
# Or for user-level (all projects): # Or for user-level (all projects):
npm run cursor:install -- user bun run cursor:install -- user
``` ```
This installs: This installs:
@@ -121,7 +121,7 @@ This installs:
## Step 4: Start the Worker ## Step 4: Start the Worker
```bash ```bash
npm run worker:start bun run worker:start
``` ```
The worker runs in the background and handles: The worker runs in the background and handles:
@@ -136,7 +136,7 @@ The worker runs in the background and handles:
2. **Check installation status**: 2. **Check installation status**:
```bash ```bash
npm run cursor:status bun run cursor:status
``` ```
3. **Verify the worker is running**: 3. **Verify the worker is running**:
@@ -196,12 +196,12 @@ If you hit the 1500 requests/day limit:
| Command | Purpose | | Command | Purpose |
|---------|---------| |---------|---------|
| `npm run cursor:install` | Install hooks for current project | | `bun run cursor:install` | Install hooks for current project |
| `npm run cursor:install -- user` | Install hooks for all projects | | `bun run cursor:install -- user` | Install hooks for all projects |
| `npm run cursor:status` | Check installation status | | `bun run cursor:status` | Check installation status |
| `npm run worker:start` | Start the background worker | | `bun run worker:start` | Start the background worker |
| `npm run worker:stop` | Stop the background worker | | `bun run worker:stop` | Stop the background worker |
| `npm run worker:restart` | Restart the worker | | `bun run worker:restart` | Restart the worker |
--- ---
@@ -223,8 +223,8 @@ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
# Clone and build # Clone and build
git clone https://github.com/thedotmack/claude-mem.git git clone https://github.com/thedotmack/claude-mem.git
cd claude-mem cd claude-mem
npm install bun install
npm run build bun run build
# Configure provider (Gemini example) # Configure provider (Gemini example)
$settingsDir = "$env:USERPROFILE\.claude-mem" $settingsDir = "$env:USERPROFILE\.claude-mem"
@@ -238,11 +238,11 @@ New-Item -ItemType Directory -Force -Path $settingsDir
"@ | Out-File -FilePath "$settingsDir\settings.json" -Encoding UTF8 "@ | Out-File -FilePath "$settingsDir\settings.json" -Encoding UTF8
# Interactive setup (recommended - walks you through everything) # Interactive setup (recommended - walks you through everything)
npm run cursor:setup bun run cursor:setup
# Or manual installation # Or manual installation
npm run cursor:install bun run cursor:install
npm run worker:start bun run worker:start
``` ```
### What Gets Installed on Windows ### What Gets Installed on Windows
docs/public/cursor/gemini-setup.mdx
+8 -8
View File
@@ -32,10 +32,10 @@ git clone https://github.com/thedotmack/claude-mem.git
cd claude-mem cd claude-mem
# Install dependencies # Install dependencies
npm install bun install
# Build the project # Build the project
npm run build bun run build
``` ```
## Step 3: Configure Gemini Provider ## Step 3: Configure Gemini Provider
@@ -45,7 +45,7 @@ npm run build
Run the setup wizard which guides you through everything: Run the setup wizard which guides you through everything:
```bash ```bash
npm run cursor:setup bun run cursor:setup
``` ```
The wizard will: The wizard will:
@@ -77,8 +77,8 @@ Replace `YOUR_GEMINI_API_KEY` with your actual API key.
Then install hooks and start the worker: Then install hooks and start the worker:
```bash ```bash
npm run cursor:install bun run cursor:install
npm run worker:start bun run worker:start
``` ```
## Step 4: Restart Cursor ## Step 4: Restart Cursor
@@ -89,10 +89,10 @@ Close and reopen Cursor IDE for the hooks to take effect.
```bash ```bash
# Check worker is running # Check worker is running
npm run worker:status bun run worker:status
# Check hooks are installed # Check hooks are installed
npm run cursor:status bun run cursor:status
``` ```
Open http://localhost:37777 to see the memory viewer. 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: Check the worker logs:
```bash ```bash
npm run worker:logs bun run worker:logs
``` ```
Look for error messages related to Gemini API calls. Look for error messages related to Gemini API calls.
docs/public/cursor/index.mdx
+18 -18
View File
@@ -48,10 +48,10 @@ If you're using Cursor without a Claude Code subscription:
```bash ```bash
# Clone and build # Clone and build
git clone https://github.com/thedotmack/claude-mem.git 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 # Run interactive setup wizard
npm run cursor:setup bun run cursor:setup
``` ```
The setup wizard will: The setup wizard will:
@@ -83,17 +83,17 @@ The plugin uses Claude's SDK by default but you can switch to Gemini or OpenRout
<AccordionGroup> <AccordionGroup>
<Accordion title="macOS"> <Accordion title="macOS">
- Node.js 18+ - [Bun](https://bun.sh): `curl -fsSL https://bun.sh/install | bash`
- Cursor IDE - Cursor IDE
- jq and curl: `brew install jq curl` - jq and curl: `brew install jq curl`
</Accordion> </Accordion>
<Accordion title="Linux"> <Accordion title="Linux">
- Node.js 18+ - [Bun](https://bun.sh): `curl -fsSL https://bun.sh/install | bash`
- Cursor IDE - Cursor IDE
- jq and curl: `apt install jq curl` or `dnf install jq curl` - jq and curl: `apt install jq curl` or `dnf install jq curl`
</Accordion> </Accordion>
<Accordion title="Windows"> <Accordion title="Windows">
- Node.js 18+ - [Bun](https://bun.sh): `powershell -c "irm bun.sh/install.ps1 | iex"`
- Cursor IDE - Cursor IDE
- PowerShell 5.1+ (included in Windows 10/11) - PowerShell 5.1+ (included in Windows 10/11)
- Git for Windows - Git for Windows
@@ -106,13 +106,13 @@ After installation, these commands are available from the claude-mem directory:
| Command | Description | | Command | Description |
|---------|-------------| |---------|-------------|
| `npm run cursor:setup` | Interactive setup wizard | | `bun run cursor:setup` | Interactive setup wizard |
| `npm run cursor:install` | Install Cursor hooks | | `bun run cursor:install` | Install Cursor hooks |
| `npm run cursor:uninstall` | Remove Cursor hooks | | `bun run cursor:uninstall` | Remove Cursor hooks |
| `npm run cursor:status` | Check hook installation status | | `bun run cursor:status` | Check hook installation status |
| `npm run worker:start` | Start the worker service | | `bun run worker:start` | Start the worker service |
| `npm run worker:stop` | Stop the worker service | | `bun run worker:stop` | Stop the worker service |
| `npm run worker:status` | Check worker status | | `bun run worker:status` | Check worker status |
## Verifying Installation ## Verifying Installation
@@ -120,12 +120,12 @@ After setup, verify everything is working:
1. **Check worker status:** 1. **Check worker status:**
```bash ```bash
npm run worker:status bun run worker:status
``` ```
2. **Check hook installation:** 2. **Check hook installation:**
```bash ```bash
npm run cursor:status bun run cursor:status
``` ```
3. **Open the memory viewer:** 3. **Open the memory viewer:**
@@ -154,21 +154,21 @@ After setup, verify everything is working:
lsof -i :37777 lsof -i :37777
# Force restart # Force restart
npm run worker:stop && npm run worker:start bun run worker:stop && bun run worker:start
# Check logs # Check logs
npm run worker:logs bun run worker:logs
``` ```
### Hooks not firing ### Hooks not firing
1. Restart Cursor IDE after installation 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 3. Verify hooks.json exists in `.cursor/` directory
### No context appearing ### 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 2. Check that you have observations: visit http://localhost:37777
3. Verify your API key is configured correctly 3. Verify your API key is configured correctly
docs/public/cursor/openrouter-setup.mdx
+8 -8
View File
@@ -31,10 +31,10 @@ git clone https://github.com/thedotmack/claude-mem.git
cd claude-mem cd claude-mem
# Install dependencies # Install dependencies
npm install bun install
# Build the project # Build the project
npm run build bun run build
``` ```
## Step 3: Configure OpenRouter Provider ## Step 3: Configure OpenRouter Provider
@@ -44,7 +44,7 @@ npm run build
Run the setup wizard which guides you through everything: Run the setup wizard which guides you through everything:
```bash ```bash
npm run cursor:setup bun run cursor:setup
``` ```
When prompted for provider, select **OpenRouter**. 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: Then install hooks and start the worker:
```bash ```bash
npm run cursor:install bun run cursor:install
npm run worker:start bun run worker:start
``` ```
## Step 4: Restart Cursor ## Step 4: Restart Cursor
@@ -83,10 +83,10 @@ Close and reopen Cursor IDE for the hooks to take effect.
```bash ```bash
# Check worker is running # Check worker is running
npm run worker:status bun run worker:status
# Check hooks are installed # Check hooks are installed
npm run cursor:status bun run cursor:status
``` ```
Open http://localhost:37777 to see the memory viewer. 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: Check the worker logs for details:
```bash ```bash
npm run worker:logs bun run worker:logs
``` ```
Common issues: Common issues: