docs: update installation instructions and scripts for npm package

vinhnx · vinhnx · commit fa44286b1f8f · 2025-12-24T23:45:45.000+07:00
- Update README.md to show npm as the primary installation method
- Update install.sh to attempt npm installation first (recommended)
- Update install.ps1 to attempt npm installation first (recommended)
- Change npm package name from @vinhnx/vtcode (GitHub) to vtcode (npmjs.com)
- Remove old vtcode-bin references from installation scripts
- Add install-with-npm function to both bash and PowerShell installers
diff --git a/README.md b/README.md
@@ -69,14 +69,14 @@ irm https://raw.githubusercontent.com/vinhnx/vtcode/main/scripts/install.ps1 | i
 **Other Distribution Channels:**
 
 ```bash
-# Cargo
+# Cargo (Rust package manager)
 cargo install vtcode
 
-# Homebrew
+# Homebrew (macOS/Linux)
 brew install vinhnx/tap/vtcode
 
-# NPM (GitHub Registry)
-npm install -g @vinhnx/vtcode --registry=https://npm.pkg.github.com
+# NPM (Node.js - Recommended)
+npm install -g vtcode
 ```
 
 **See [Installation Guide](./docs/installation/) for more options and troubleshooting.**
diff --git a/scripts/install.ps1 b/scripts/install.ps1
@@ -13,6 +13,31 @@ $ProgressPreference = 'SilentlyContinue'
 function Write-Log { Write-Host "➜ $args" -ForegroundColor Cyan }
 function Write-Success { Write-Host "✓ $args" -ForegroundColor Green }
 function Write-Error-Msg { Write-Host "✗ $args" -ForegroundColor Red }
+function Write-Warn { Write-Host "⚠ $args" -ForegroundColor Yellow }
+
+# Install with npm (recommended)
+function Install-WithNpm {
+    if (Get-Command npm -ErrorAction SilentlyContinue) {
+        Write-Log "Installing with npm (recommended)..."
+        try {
+            npm install -g vtcode
+            Write-Success "Successfully installed vtcode via npm"
+            Write-Host ""
+            Write-Host "VT Code has been installed globally. You can now run: vtcode"
+            Write-Host ""
+            Write-Host "To get started:"
+            Write-Host "  vtcode --help"
+            Write-Host ""
+            return $true
+        } catch {
+            Write-Warn "NPM installation failed: $_"
+            return $false
+        }
+    } else {
+        Write-Warn "npm not found, falling back to GitHub releases..."
+        return $false
+    }
+}
 
 # Get version
 function Get-Version {
@@ -158,6 +183,15 @@ Write-Host "VT Code Installer" -ForegroundColor Cyan
 Write-Host "=================" -ForegroundColor Cyan
 Write-Host ""
 
+# Try npm first (recommended)
+if (Install-WithNpm) {
+    exit 0
+}
+
+Write-Warn "NPM installation failed or npm not found, falling back to GitHub releases..."
+Write-Host ""
+
+# Fall back to GitHub releases
 $version = Get-Version
 $binInfo = Get-Binary -Version $version
 $binary = Install-Binary $binInfo
diff --git a/scripts/install.sh b/scripts/install.sh
@@ -1,6 +1,8 @@
 #!/bin/bash
 # VT Code Installer
-# Usage: curl -fsSL https://raw.githubusercontent.com/vinhnx/vtcode/main/scripts/install.sh | bash [version]
+# Usage: 
+#   Recommended: curl -fsSL https://raw.githubusercontent.com/vinhnx/vtcode/main/scripts/install.sh | bash [version]
+#   Alternative: npm install -g vtcode
 
 set -e
 
@@ -262,6 +264,31 @@ install_with_cargo() {
     fi
 }
 
+# Install with npm as primary option when available
+install_with_npm() {
+    if command -v npm >/dev/null 2>&1; then
+        log "Installing with npm (recommended)..."
+        log "Running: npm install -g vtcode"
+        
+        if npm install -g vtcode; then
+            success "Successfully installed vtcode via npm"
+            echo ""
+            echo "VT Code has been installed globally. You can now run: vtcode"
+            echo ""
+            echo "To get started:"
+            echo "  vtcode --help"
+            echo ""
+            exit 0
+        else
+            warn "NPM installation failed"
+            return 1
+        fi
+    else
+        verbose "npm not found, skipping npm installation"
+        return 1
+    fi
+}
+
 # Main logic
 main() {
     # Check dependencies first
@@ -284,7 +311,16 @@ main() {
         exit 1
     fi
     
-    # Check if release has assets before proceeding
+    log "Installing VT Code v${VERSION}..."
+    
+    # Try npm first (recommended, fastest method)
+    if install_with_npm; then
+        exit 0
+    fi
+    
+    warn "NPM installation failed or npm not found, falling back to GitHub releases..."
+    
+    # Check if release has assets before proceeding with download
     if ! check_release_assets "$VERSION" "$PLATFORM"; then
         warn "Missing pre-built binaries for v${VERSION} on $PLATFORM"
         warn ""
@@ -409,6 +445,7 @@ main() {
         echo "  Brew:  brew install vinhnx/tap/vtcode"
     fi
     echo "  NPM:   npm install -g @vinhnx/vtcode --registry=https://npm.pkg.github.com"
+    echo "  NPM:   npm install -g vtcode (recommended)"
     echo "  GitHub: https://github.com/$GITHUB_REPO/releases"
     echo ""
     success "Installation complete!"
