polaris-vpn 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ 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

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.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polaris-vpn",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Your True North in Digital Privacy. A self-hosted VPN CLI.",
   "type": "module",
   "bin": {

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], {