polaris-vpn 0.4.0 → 0.6.0

package/CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.0] - 2026-07-12
+
+### Added
+
+- **First-Class Windows Support**: Polaris now natively binds to `wireguard.exe` NT Services on Windows, bypassing the need for `wg-quick` and `sudo`. This makes Polaris fully cross-platform.
+
+## [0.5.0] - 2026-07-12
+
+### Added
+
+- **Server Health Dashboard**: `polaris status --full` now queries GeoIP data, tests ping latency directly to the server, and retrieves live WireGuard rx/tx data limits.
+- **Auto-Updater**: Introduced `polaris update` and background update notifications via `update-notifier`.
+
 ## [0.4.0] - 2026-07-12
 
 ### Added

package/README.md

@@ -4,10 +4,12 @@
 
 Your True North in Digital Privacy. `polaris` is a production-quality, open-source, self-hosted VPN CLI tool. It wraps SSH dynamic port forwarding into a beautiful CLI experience.
 
-## Prerequisites
+### Prerequisites
 
-- SSH access to any VPS (Virtual Private Server).
-- Node.js >= 18
+- Node.js (v18+)
+- SSH access to a remote Linux VPS (Ubuntu/Debian recommended)
+- **Linux/macOS**: `sudo` privileges for configuring WireGuard and network routes locally.
+- **Windows**: The official [WireGuard for Windows](https://www.wireguard.com/install/) client must be installed, and `polaris` must be run from an Administrator prompt.
 
 We highly recommend **Oracle Cloud Free Tier** for your VPS.
 
@@ -45,13 +47,14 @@ polaris stop
 | --- | --- |
 | `polaris start --server user@host [--port 1080]` | Start the encrypted SSH tunnel. |
 | `polaris stop` | Stop the active tunnel. |
-| `polaris status` | Show current tunnel status, IP, and uptime. |
+| `polaris status [--full]` | Show current tunnel status. `--full` shows GeoIP, ping latency, and WG stats. |
 | `polaris monitor` | Live bandwidth monitor for WireGuard tunnels. |
 | `polaris check` | Run a 3-point privacy check (IP, DNS leak, IPv6 leak). |
 | `polaris add <alias> --server user@host` | Save a server profile for quick access. |
 | `polaris list` | List all saved server profiles. |
 | `polaris use <alias>` | Set a saved profile as the active default. |
 | `polaris server start` | Start a local REST API on `127.0.0.1:7070`. |
+| `polaris update` | Update `polaris-vpn` to the latest version via npm. |
 
 > All commands support the `--json` flag for machine-readable output.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polaris-vpn",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Your True North in Digital Privacy. A self-hosted VPN CLI.",
   "type": "module",
   "bin": {
@@ -44,6 +44,7 @@
     "qrcode-terminal": "^0.12.0",
     "socks-proxy-agent": "^10.1.0",
     "ssh2": "^1.17.0",
+    "update-notifier": "^7.3.1",
     "wireguard-tools": "^0.1.0"
   }
 }

package/src/cli.js

@@ -3,12 +3,17 @@ import { Command } from 'commander';
 import { readFileSync } from 'fs';
 import { fileURLToPath } from 'url';
 import path from 'path';
-import { printBanner, printError } from './utils/display.js';
+import updateNotifier from 'update-notifier';
+import { spawnSync } from 'child_process';
+import { printBanner, printError, printSuccess } from './utils/display.js';
+import chalk from 'chalk';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const pkg = JSON.parse(readFileSync(path.join(__dirname, '..', 'package.json'), 'utf-8'));
 
+updateNotifier({ pkg }).notify();
+
 const program = new Command();
 
 program
@@ -20,6 +25,20 @@ program
 // Helper to check if we should print the banner
 const willPrintJson = () => process.argv.includes('--json');
 
+program
+  .command('update')
+  .description('Update polaris-vpn to the latest version')
+  .action(() => {
+    console.log(chalk.cyan('Updating polaris-vpn...'));
+    const res = spawnSync('npm', ['install', '-g', 'polaris-vpn@latest'], { stdio: 'inherit' });
+    if (res.status === 0) {
+      printSuccess('Successfully updated to the latest version!');
+    } else {
+      printError('Failed to update polaris-vpn.');
+      process.exitCode = 1;
+    }
+  });
+
 program
   .command('start')
   .description('Start the encrypted SSH, TLS or WireGuard tunnel')
@@ -54,6 +73,7 @@ program
 program
   .command('status')
   .description('Show current tunnel status, IP, and uptime')
+  .option('--full', 'Show GeoIP, latency, and full data usage stats')
   .action(async (options, cmd) => {
     if (!cmd.optsWithGlobals().json) printBanner();
     try {

package/src/commands/status.js

@@ -2,9 +2,64 @@ import { getActiveTunnel } from '../core/tunnel-service.js';
 import { getProxiedIp } from '../net/ip-check.js';
 import { createTable, createSpinner, printError } from '../utils/display.js';
 import chalk from 'chalk';
+import fetch from 'node-fetch';
+import { spawnSync } from 'child_process';
+import os from 'os';
+
+const pingServer = (ip) => {
+  const isWin = os.platform() === 'win32';
+  const args = isWin ? ['-n', '1', '-w', '2000', ip] : ['-c', '1', '-W', '2', ip];
+  const res = spawnSync('ping', args, { encoding: 'utf-8' });
+  if (res.status === 0) {
+    if (isWin) {
+      const match = res.stdout.match(/Average = (\d+)ms/);
+      if (match) return `${match[1]} ms`;
+    } else {
+      const match = res.stdout.match(/time=([\d.]+)\s*ms/);
+      if (match) return `${match[1]} ms`;
+    }
+  }
+  return 'Timeout';
+};
+
+const getGeoIp = async (ip) => {
+  try {
+    const res = await fetch(`http://ip-api.com/json/${ip}`);
+    const data = await res.json();
+    if (data.status === 'success') {
+      return `${data.city}, ${data.country} (${data.isp})`;
+    }
+  } catch (err) {}
+  return 'Unknown';
+};
+
+const formatBytes = (bytes) => {
+  if (bytes === 0) return '0 B';
+  const k = 1024;
+  const sizes = ['B', 'KB', 'MB', 'GB', 'TB'];
+  const i = Math.floor(Math.log(bytes) / Math.log(k));
+  return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
+};
+
+const getWgStats = () => {
+  const dumpRes = spawnSync('sudo', ['wg', 'show', 'all', 'dump'], { encoding: 'utf-8' });
+  if (dumpRes.status !== 0) return null;
+  const lines = dumpRes.stdout.trim().split('\n');
+  if (lines.length <= 1) return null;
+  
+  let totalRx = 0;
+  let totalTx = 0;
+  for (let i = 1; i < lines.length; i++) {
+    const peerInfo = lines[i].split('\t');
+    totalRx += parseInt(peerInfo[6], 10) || 0;
+    totalTx += parseInt(peerInfo[7], 10) || 0;
+  }
+  return { totalRx, totalTx };
+};
 
 export default async (options) => {
   const isJson = options.json;
+  const isFull = options.full;
   const info = getActiveTunnel();
   
   if (!info) {
@@ -23,9 +78,33 @@ export default async (options) => {
     currentIp = await getProxiedIp(info.port);
     if (spinner) spinner.stop();
     
+    let geo = 'N/A';
+    let latency = 'N/A';
+    let dataUsage = 'N/A';
+
+    if (isFull) {
+      if (spinner) {
+        spinner.text = 'Fetching full health data...';
+        spinner.start();
+      }
+      
+      const serverIp = info.server.split('@').pop();
+      latency = pingServer(serverIp);
+      geo = await getGeoIp(currentIp);
+
+      if (info.mode === 'wireguard') {
+        const stats = getWgStats();
+        if (stats) {
+          dataUsage = `${formatBytes(stats.totalRx)} / ${formatBytes(stats.totalTx)}`;
+        }
+      }
+      
+      if (spinner) spinner.stop();
+    }
+    
     if (isJson) {
       const uptimeMs = Date.now() - new Date(info.startTime).getTime();
-      console.log(JSON.stringify({
+      const payload = {
         status: 'up',
         server: info.server,
         port: info.port,
@@ -33,7 +112,13 @@ export default async (options) => {
         mode: info.mode || 'ssh',
         ip: currentIp,
         uptimeMs
-      }));
+      };
+      if (isFull) {
+        payload.geo = geo;
+        payload.latency = latency;
+        payload.dataUsage = dataUsage;
+      }
+      console.log(JSON.stringify(payload));
     } else {
       console.log(chalk.green.bold('\n● Tunnel is UP\n'));
       
@@ -49,6 +134,14 @@ export default async (options) => {
         ['Uptime', `${uptimeMin} minutes`],
         ['PID', info.pid.toString()]
       );
+
+      if (isFull) {
+        table.push(
+          ['Geo Location', geo],
+          ['Latency (Ping)', latency],
+          ['Data (Rx/Tx)', dataUsage]
+        );
+      }
       
       console.log(table.toString());
       console.log('');

package/src/tunnel/wg.js

@@ -27,10 +27,27 @@ export const generateKeyPair = () => {
   };
 };
 
+import os from 'os';
+import path from 'path';
+
 export const startWgTunnel = (confPath, isJson = false) => {
-  const sudoCheck = spawnSync('sudo', ['-n', 'true']);
-  if (sudoCheck.status !== 0 && isJson) {
-    throw new Error('Sudo privileges required. Please run with "sudo polaris start ..." for JSON mode.');
+  const isWin = os.platform() === 'win32';
+
+  if (!isWin) {
+    const sudoCheck = spawnSync('sudo', ['-n', 'true']);
+    if (sudoCheck.status !== 0 && isJson) {
+      throw new Error('Sudo privileges required. Please run with "sudo polaris start ..." for JSON mode.');
+    }
+  }
+
+  if (isWin) {
+    const res = spawnSync('wireguard', ['/installtunnelservice', confPath], {
+      stdio: isJson ? 'ignore' : 'inherit'
+    });
+    if (res.status !== 0) {
+      throw new Error(`wireguard /installtunnelservice failed (ensure Admin privileges) with code ${res.status}`);
+    }
+    return process.pid;
   }
 
   const res = spawnSync('sudo', ['wg-quick', 'up', confPath], {
@@ -44,9 +61,24 @@ export const startWgTunnel = (confPath, isJson = false) => {
 };
 
 export const stopWgTunnel = (confPath, isJson = false) => {
-  const sudoCheck = spawnSync('sudo', ['-n', 'true']);
-  if (sudoCheck.status !== 0 && isJson) {
-    throw new Error('Sudo privileges required. Please run with "sudo polaris stop" for JSON mode.');
+  const isWin = os.platform() === 'win32';
+
+  if (!isWin) {
+    const sudoCheck = spawnSync('sudo', ['-n', 'true']);
+    if (sudoCheck.status !== 0 && isJson) {
+      throw new Error('Sudo privileges required. Please run with "sudo polaris stop" for JSON mode.');
+    }
+  }
+
+  if (isWin) {
+    const interfaceName = path.parse(confPath).name;
+    const res = spawnSync('wireguard', ['/uninstalltunnelservice', interfaceName], {
+      stdio: isJson ? 'ignore' : 'inherit'
+    });
+    if (res.status !== 0) {
+      throw new Error(`wireguard /uninstalltunnelservice failed with code ${res.status}`);
+    }
+    return;
   }
 
   const res = spawnSync('sudo', ['wg-quick', 'down', confPath], {