projax 3.3.1 → 3.3.3

package/README.md

@@ -1,6 +1,14 @@
 # projax
 
-A cross-platform project management dashboard for tracking local development projects. Features a powerful CLI tool, interactive Terminal UI (TUI), Desktop app (Electron-based), REST API, and built-in tools for test detection, port management, and script execution.
+A cross-platform project management dashboard for tracking local development projects. Features a powerful CLI tool, interactive Terminal UI (TUI), Desktop app (Electron-based), **VS Code/Cursor/Windsurf extension**, REST API, and built-in tools for test detection, port management, and script execution.
+
+## 🌟 Key Interfaces
+
+- **🖥️ CLI**: Full-featured command-line tool - `prx <command>`
+- **⚡ Terminal UI**: Interactive TUI with real-time updates - `prx i`
+- **🎨 Desktop App**: Beautiful Electron-based UI - `prx web`
+- **📝 Editor Extension**: Native sidebar for VS Code, Cursor, and Windsurf - [Get Extension](#vscode-cursorf-windsurf-extension)
+- **🔌 REST API**: Express-based API server for integrations
 
 ## Features
 
@@ -11,7 +19,9 @@ A cross-platform project management dashboard for tracking local development pro
 - **Intelligent Script Selection**: Automatically selects the right script (dev/start) when running projects
 - **Port Scanning & Indexing**: Automatically extracts and indexes ports from project config files
 - **CLI Interface**: Full-featured command-line tool for project management
-- **Web Interface**: Beautiful Desktop UI (Electron-based) for visual project management
+- **Terminal UI (TUI)**: Interactive terminal interface with real-time updates
+- **Desktop App**: Beautiful Desktop UI (Electron-based) for visual project management
+- **Editor Extension**: Native sidebar extension for VS Code, Cursor, and Windsurf editors
 - **JSON Database**: Lightweight JSON-based database stores all project metadata
 - **REST API**: Express-based API server for centralized data access
 - **Cross-Platform Support**: Works on macOS, Linux, and Windows
@@ -26,6 +36,40 @@ npm install -g projax
 
 After installation, the `prx` command will be available globally.
 
+## VS Code/Cursor/Windsurf Extension
+
+**PROJAX for Editors** brings the power of PROJAX directly into your editor's sidebar with a native extension for VS Code, Cursor, and Windsurf.
+
+### 🎯 Features
+
+- **📂 Projects Browser**: Search and browse all PROJAX projects in a sidebar panel
+- **🎯 Auto-Detection**: Automatically detects and highlights the current workspace project
+- **📊 Project Details**: View tests, ports, scripts, and statistics at a glance
+- **▶️ Script Execution**: Run and stop npm/yarn scripts directly from the editor
+- **🔗 Quick Access**: One-click access to development server URLs
+- **⌨️ Command Palette**: 13 PROJAX commands accessible via `Cmd+Shift+P`
+- **🔄 Real-Time Updates**: Live process status and port information
+- **🎨 Native UI**: Beautiful sidebar panels that match your editor's theme
+
+### 📦 Installation
+
+```bash
+# Get installation instructions and .vsix location
+prx vscode-extension
+
+# Or install directly:
+code --install-extension ./release/projax-vscode-3.0.0.vsix      # VS Code
+cursor --install-extension ./release/projax-vscode-3.0.0.vsix    # Cursor
+windsurf --install-extension ./release/projax-vscode-3.0.0.vsix  # Windsurf
+```
+
+### 📚 Documentation
+
+- [Extension Overview](https://projax.dev/docs/editors/overview)
+- [Installation Guide](https://projax.dev/docs/editors/installation)
+- [Usage Guide](https://projax.dev/docs/editors/usage)
+- [Command Reference](https://projax.dev/docs/editors/commands)
+
 ### Database Setup
 
 The database is automatically created on first use. No manual setup required.

package/dist/index.js

@@ -1482,30 +1482,33 @@ program
         }
         else {
             const vsixPath = path.join(releaseDir, vsixFiles[0]);
-            console.log(`✅ Extension package: ${vsixFiles[0]}`);
+            console.log(`✅ Extension: ${vsixFiles[0]}`);
             console.log(`📁 Location: ${vsixPath}\n`);
-            console.log('📖 Installation Instructions:\n');
-            console.log('1. Open VS Code, Cursor, or Windsurf');
-            console.log('2. Go to Extensions (Cmd+Shift+X / Ctrl+Shift+X)');
-            console.log('3. Click the "..." menu → "Install from VSIX..."');
-            console.log(`4. Navigate to: ${releaseDir}`);
-            console.log(`5. Select: ${vsixFiles[0]}\n`);
-            console.log('🚀 Quick Install:\n');
+            console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
+            console.log('🚀 QUICK INSTALL (Easiest Method)');
+            console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n');
             console.log(`   code --install-extension "${vsixPath}"`);
             console.log(`   cursor --install-extension "${vsixPath}"`);
             console.log(`   windsurf --install-extension "${vsixPath}"\n`);
+            console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
+            console.log('📖 Manual Installation');
+            console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n');
+            console.log('1. Open VS Code, Cursor, or Windsurf');
+            console.log('2. Go to Extensions (Cmd+Shift+X / Ctrl+Shift+X)');
+            console.log('3. Click the "..." menu → "Install from VSIX..."');
+            console.log(`4. Select: ${vsixPath}\n`);
             // Open in Finder/Explorer
             const platform = process.platform;
             if (platform === 'darwin') {
-                console.log('💡 Open in Finder:');
+                console.log('💡 Open release folder in Finder:');
                 console.log(`   open "${releaseDir}"\n`);
             }
             else if (platform === 'win32') {
-                console.log('💡 Open in Explorer:');
+                console.log('💡 Open release folder in Explorer:');
                 console.log(`   explorer "${releaseDir}"\n`);
             }
             else {
-                console.log('💡 Open in File Manager:');
+                console.log('💡 Open release folder:');
                 console.log(`   xdg-open "${releaseDir}"\n`);
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "projax",
-  "version": "3.3.1",
+  "version": "3.3.3",
   "description": "Cross-platform project management dashboard for tracking local development projects. Features CLI, Terminal UI, Desktop app, REST API, and built-in tools for test detection, port management, and script execution.",
   "main": "dist/index.js",
   "bin": {