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.
This commit is contained in:
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="macOS">
|
||||
- Node.js 18+
|
||||
- [Bun](https://bun.sh): `curl -fsSL https://bun.sh/install | bash`
|
||||
- Cursor IDE
|
||||
- jq and curl: `brew install jq curl`
|
||||
</Accordion>
|
||||
<Accordion title="Linux">
|
||||
- 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`
|
||||
</Accordion>
|
||||
<Accordion title="Windows">
|
||||
- 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
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user