polaris-vpn 1.1.0 → 1.1.2

package/CHANGELOG.md

@@ -5,6 +5,16 @@ 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).
 
+## [1.1.2] - 2026-07-22
+
+### Fixed
+
+- **Start Command**: Fixed `ReferenceError: config is not defined` crash when invoking `polaris start` without `--server` argument.
+- **WireGuard & AmneziaWG Status**: Fixed `polaris status` and `polaris check` reporting false proxy failures for system-wide VPN interfaces.
+- **AmneziaWG Bandwidth Monitoring**: Updated `polaris monitor`, `dashboard`, `status`, and TUI components to query `awg` interface statistics and accept `--mode amneziawg`.
+- **Deploy Local Auto-Connect**: Updated `polaris deploy` to automatically trigger local connection passing correct server and mode arguments upon provisioning completion.
+- **Status Table Formatting**: Replaced invalid SOCKS5 proxy port display (`socks5://127.0.0.1:0`) with clear `System-wide (All OS traffic)` label for WireGuard and AmneziaWG connections.
+
 ## [1.0.0] - 2026-07-15
 
 ### Added

package/README.md

@@ -1,132 +1,109 @@
-# polaris — Leave no trace
+# Polaris VPN
 
-![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)
+![Polaris VPN Terminal Demo](./docs/demo.gif)
 
-<div align="center">
-  <img src="./docs/demo.gif" alt="Polaris VPN Terminal Demo" width="800">
-</div>
+**Command your privacy.**
 
-Your True North in Digital Privacy. `polaris` is a production-quality, open-source, self-hosted VPN CLI tool. It supports SSH dynamic port forwarding, WireGuard, and AmneziaWG (Stealth) tunnels.
+[![NPM Version](https://img.shields.io/npm/v/polaris-vpn?color=88c0d0&label=npm&style=flat-square)](https://www.npmjs.com/package/polaris-vpn)
+[![License](https://img.shields.io/badge/license-Apache%202.0-5e81ac?style=flat-square)](https://github.com/Divyo/polaris-vpn)
+[![Node version](https://img.shields.io/badge/node-%3E%3D%2018.0.0-a3be8c?style=flat-square)](https://nodejs.org)
+![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-ebcb8b?style=flat-square)
 
-### Prerequisites
+A production-grade, self-hosted VPN CLI with a beautiful Terminal User
+Interface (TUI).
 
-- 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.
+Deploy an enterprise-grade WireGuard or Stealth VPN in under 60 seconds.
 
-We highly recommend **Oracle Cloud Free Tier** for your VPS.
+---
 
-## Install
+## ✨ Features
 
-```bash
-npm install -g polaris-vpn
-```
+- **🚀 Automated Deployment**: Instantly provision a WireGuard or AmneziaWG VPN
+  on any fresh Linux VPS.
+- **🎨 Beautiful TUI**: A master dashboard with real-time bandwidth
+  monitoring, ping latency, and server locations.
+- **🛡️ Smart Kill-Switch**: Native OS firewall integration (`pf` for Mac,
+  `iptables` for Linux) that ensures 0 leaks.
+- **👻 Stealth Mode**: DPI (Deep Packet Inspection) bypass using AmneziaWG to
+  defeat state-level censorship.
+- **🔗 SSH Fallback**: Can't install WireGuard? Polaris seamlessly falls back
+  to an encrypted SOCKS5 SSH tunnel.
+- **☁️ Own Your Infra**: We run no servers. You bring your own VPS (Oracle
+  Free Tier recommended).
 
-## Quickstart (30 seconds)
-
-Once you have your server's IP address and SSH credentials (e.g. `ubuntu@1.2.3.4`), just run:
+## 📦 Installation
 
 ```bash
-polaris start --server ubuntu@1.2.3.4
+npm install -g polaris-vpn
 ```
 
-This will instantly create an encrypted SOCKS5 proxy on `127.0.0.1:1080` and route your traffic through it.
-
-Verify it's working:
+Requires Node.js 18+
 
-```bash
-polaris check
-```
+## ⚡ Quick Start
 
-When you're done:
+Got a fresh Linux VPS? Let Polaris set everything up for you.
 
 ```bash
-polaris stop
-```
-
-## Command Reference
-
-| Command | Description |
-| --- | --- |
-| `polaris deploy --server user@host --mode amneziawg` | Provision server with AmneziaWG (Stealth Mode) |
-| `polaris start --server user@host [--port 1080] [--mode <type>]` | Start the encrypted tunnel. |
-| `polaris stop` | Stop the active tunnel. |
-| `polaris dashboard` | Opens a rich Terminal User Interface (TUI) with real-time stats. |
-| `polaris status [--full]` | Show current tunnel status. `--full` shows GeoIP, ping latency, and WG stats. |
-| `polaris monitor` | Live bandwidth monitor for WireGuard tunnels. |
-| `polaris killswitch on/off` | Enable or disable the system-wide VPN kill switch. |
-| `polaris peer add <name>` | Generate and add a new peer config for WireGuard/AmneziaWG. |
-| `polaris peer list` | List all peers configured on the server. |
-| `polaris peer remove <name>` | Revoke a peer from the server. |
-| `polaris peer qr <name>` | Display the peer config as a QR code for mobile devices. |
-| `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. |
+# 1. Provision the server automatically
+polaris deploy --server root@1.2.3.4 --mode amneziawg
 
-#### `polaris dashboard`
-
-Opens a rich Terminal User Interface (TUI) with real-time graphs, server location maps, and live statistics (Rx/Tx, Ping).
-
-#### `polaris status [--full]`
-
-Displays the connection state, mode, current proxy IP, and active server. Use `--full` to query GeoIP and ping latency.
+# 2. Connect to your new VPN
+polaris start --server root@1.2.3.4
+```
 
-#### `polaris monitor`
+> **Pro Tip**: Run `polaris add my-server --server root@1.2.3.4`
+> so you can just type `polaris start` next time!
 
-Live bandwidth monitor that actively graphs the download and upload speeds of your tunnel.
+## 🖥️ The Dashboard
 
-#### `polaris check`
+Experience the modern terminal UI by running:
 
-Checks if your IP matches the proxy, tests for DNS leaks via `ipleak.net`, and verifies IPv6 routing.
+```bash
+polaris
+```
 
-> All commands support the `--json` flag for machine-readable output.
+Use your **Arrow Keys** to navigate through:
 
-## Oracle Cloud Free Tier Setup
+- **Home**: Quick connect/disconnect and privacy check tools.
+- **Live Monitor**: Watch your real-time Rx/Tx bandwidth graphs and server latency.
+- **Peers**: Add or revoke VPN access for friends, or generate a QR code for
+  your phone.
+- **Settings**: Manage your saved server profiles.
 
-The recommended free server is Oracle Cloud Always Free tier:
+## 🛠️ CLI Command Reference
 
-- **ARM VM (A1.Flex)**: 2 OCPUs, 12 GB RAM — completely free forever.
-- 10 TB outbound bandwidth/month — more than enough for personal use.
-- Best regions from South/Southeast Asia: India (Hyderabad) ~30ms, Singapore ~50ms, Japan (Tokyo) ~80ms.
-- Sign up at [cloud.oracle.com](https://cloud.oracle.com) (requires a credit card for verification but charges nothing for Always Free resources).
-- After VM creation, just grab the IP and SSH key, and run `polaris start --server ubuntu@<your-oracle-ip>`.
+Prefer the raw CLI? Everything is accessible via commands:
 
-## Shared Server Model
+| Command | Description |
+| :--- | :--- |
+| `polaris deploy` | Provision a server with WireGuard or AmneziaWG |
+| `polaris start` | Connect to the VPN and engage the Kill-Switch |
+| `polaris stop` | Disconnect and restore normal internet routing |
+| `polaris dashboard` | Open the TUI Live Monitor directly |
+| `polaris status --full` | Check connection state, GeoIP, and latency |
+| `polaris peer add <name>` | Generate a new peer config for a friend/device |
+| `polaris peer qr <name>` | Display the config as a QR code for mobile apps |
+| `polaris check` | Run a 3-point privacy test (IP, DNS leak, IPv6 leak) |
 
-One Oracle VM can serve multiple people:
+*(All commands support the `--json` flag for machine-readable output or scripting)*
 
-- Light browsing (1–2 Mbps/user): 25–50 people comfortably.
-- YouTube/social (5 Mbps/user): 8–10 people simultaneously.
-- One person owns the VM, others get SSH keys.
-- Or each person creates their own free Oracle account for full isolation.
+## ☁️ The Oracle Cloud Advantage
 
-## How It Works
+We highly recommend using the **Oracle Cloud Always Free Tier** to
+host your Polaris server:
 
-`polaris` uses standard SSH dynamic port forwarding (`-D` flag) behind the scenes. It sets up a secure, encrypted tunnel from your local machine to your server, and exposes a local SOCKS5 proxy. This gives you instant VPN-like privacy without installing *any* server-side software.
+- **ARM VM (A1.Flex)**: Up to 4 OCPUs and 24 GB RAM — completely free forever.
+- **10 TB Bandwidth**: More than enough for high-speed streaming and gaming.
+- No third-party VPN company logging your data or selling your traffic.
+  You are in total command.
 
-## Trust Model
+## 🔒 Trust Model
 
-- **You own the server**: No reliance on third-party VPN providers.
+- **You own the server**: No reliance on third-party commercial VPN providers.
 - **Zero telemetry**: No tracking, no crash reporting, no analytics.
-- **No central infra**: We run nothing. You bring your own VPS.
-- **Open Source**: Apache 2.0 licensed, fully auditable.
-
-## Roadmap
-
-- **v0.1**: MVP — SSH SOCKS5 tunnel
-- **v0.5**: WireGuard full tunnel + server provisioning
-- **v0.6**: Windows NT Service bindings + Blessed TUI Dashboard
-- **v0.7**: AmneziaWG stealth mode (DPI bypass)
-- **v1.0**: Multi-peer management + QR codes + Kill switch (Current)
-
-## Contributing
-
-Contributions, issues, and feature requests are welcome!
-
-## License
+- **Local Kill-Switch**: Traffic is strictly locked to the VPN interface to
+  prevent IP leaks.
+- **Open Source**: Apache 2.0 licensed, fully auditable codebase.
 
-Apache 2.0
+---
+*Built for developers who value privacy, speed, and beautiful terminal tools.*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polaris-vpn",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Your True North in Digital Privacy. A self-hosted VPN CLI.",
   "type": "module",
   "bin": {
@@ -74,5 +74,10 @@
     "socks-proxy-agent": "^10.1.0",
     "ssh2": "^1.17.0",
     "update-notifier": "^7.3.1"
+  },
+  "overrides": {
+    "lodash": "^4.18.1",
+    "uuid": "^11.1.1",
+    "xml2js": "^0.6.2"
   }
 }

package/src/commands/check.js

@@ -22,12 +22,13 @@ export default async (options) => {
     if (spinner) spinner.text = 'Checking IP address...';
     if (info) {
       try {
-        const tunnelIp = await getProxiedIp(info.port);
+        const isSystemWide = info.mode === 'wireguard' || info.mode === 'amneziawg';
+        const tunnelIp = isSystemWide ? await getPublicIp() : await getProxiedIp(info.port);
         results.ip = true;
         details.ip = `Tunnel active (${(info.mode || 'ssh').toUpperCase()}): ${tunnelIp}`;
       } catch (e) {
         results.ip = false;
-        details.ip = `Tunnel process running but proxy failed: ${e.message}`;
+        details.ip = `Tunnel active but IP check failed: ${e.message}`;
       }
     } else {
       const pubIp = await getPublicIp();

package/src/commands/dashboard.js

@@ -1,7 +1,7 @@
 import blessed from 'blessed';
 import contrib from 'blessed-contrib';
 import { getActiveTunnel } from '../core/tunnel-service.js';
-import { getProxiedIp } from '../net/ip-check.js';
+import { getProxiedIp, getPublicIp } from '../net/ip-check.js';
 import fetch from 'node-fetch';
 import { spawnSync } from 'child_process';
 import os from 'os';
@@ -67,8 +67,12 @@ const formatBytes = (bytes) => {
   return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
 };
 
-const getWgStats = () => {
-  const dumpRes = spawnSync('sudo', ['wg', 'show', 'all', 'dump'], { encoding: 'utf-8' });
+const getWgStats = (isAwg = false) => {
+  const cmd = isAwg ? 'awg' : 'wg';
+  let dumpRes = spawnSync('sudo', [cmd, 'show', 'all', 'dump'], { encoding: 'utf-8' });
+  if (dumpRes.status !== 0 && isAwg) {
+    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;
@@ -201,7 +205,8 @@ export default async () => {
     if (!geoFetched) {
       geoFetched = true;
       try {
-        currentIp = await getProxiedIp(info.port);
+        const isSystemWide = info.mode === 'wireguard' || info.mode === 'amneziawg';
+        currentIp = isSystemWide ? await getPublicIp() : await getProxiedIp(info.port);
         geoData = await getGeoIp(currentIp);
         if (geoData) {
           mapWidget.addMarker({ lat: geoData.lat, lon: geoData.lon, color: 'red', char: 'X' });
@@ -227,7 +232,7 @@ export default async () => {
 
     // 4. Update WG Stats & Chart
     if (info.mode === 'wireguard' || info.mode === 'amneziawg' || info.mode === 'auto') {
-      const stats = getWgStats();
+      const stats = getWgStats(info.mode === 'amneziawg');
       if (stats) {
         if (!hasInitWg) {
           prevRx = stats.totalRx;

package/src/commands/deploy.js

@@ -36,7 +36,8 @@ export default async (options) => {
     }
 
     // Automatically trigger local connection
-    await startCommand({ mode: 'wireguard', json: isJson });
+    const mode = options.mode || 'wireguard';
+    await startCommand({ server, mode, json: isJson });
 
   } catch (err) {
     if (spinner) spinner.fail('Deployment failed');

package/src/commands/monitor.js

@@ -49,7 +49,7 @@ export default async (options) => {
   const isJson = options.json;
   const info = getActiveTunnel();
 
-  if (!info || info.mode !== 'wireguard') {
+  if (!info || (info.mode !== 'wireguard' && info.mode !== 'amneziawg')) {
     if (isJson) {
       console.log(JSON.stringify({ error: 'WireGuard tunnel is not active' }));
     } else {

package/src/commands/start.js

@@ -51,8 +51,7 @@ export default async (options) => {
   const requestedMode = options.mode || 'auto';
 
   if (!server) {
-    const active = config.get('activeProfile');
-    const profiles = config.get('profiles') || {};
+    const { profiles, active } = getProfiles();
     
     if (active && profiles[active]) {
       server = profiles[active];

package/src/commands/status.js

@@ -1,5 +1,5 @@
 import { getActiveTunnel } from '../core/tunnel-service.js';
-import { getProxiedIp } from '../net/ip-check.js';
+import { getProxiedIp, getPublicIp } from '../net/ip-check.js';
 import { createTable, createSpinner, printError } from '../utils/display.js';
 import chalk from 'chalk';
 import fetch from 'node-fetch';
@@ -41,8 +41,12 @@ const formatBytes = (bytes) => {
   return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
 };
 
-const getWgStats = () => {
-  const dumpRes = spawnSync('sudo', ['wg', 'show', 'all', 'dump'], { encoding: 'utf-8' });
+const getWgStats = (isAwg = false) => {
+  const cmd = isAwg ? 'awg' : 'wg';
+  let dumpRes = spawnSync('sudo', [cmd, 'show', 'all', 'dump'], { encoding: 'utf-8' });
+  if (dumpRes.status !== 0 && isAwg) {
+    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;
@@ -72,10 +76,11 @@ export default async (options) => {
   }
   
   let currentIp = 'Unknown';
-  const spinner = isJson ? null : createSpinner('Checking proxy status...').start();
+  const isSystemWide = info.mode === 'wireguard' || info.mode === 'amneziawg';
+  const spinner = isJson ? null : createSpinner(isSystemWide ? 'Checking public IP...' : 'Checking proxy status...').start();
   
   try {
-    currentIp = await getProxiedIp(info.port);
+    currentIp = isSystemWide ? await getPublicIp() : await getProxiedIp(info.port);
     if (spinner) spinner.stop();
     
     let geo = 'N/A';
@@ -92,8 +97,8 @@ export default async (options) => {
       latency = pingServer(serverIp);
       geo = await getGeoIp(currentIp);
 
-      if (info.mode === 'wireguard') {
-        const stats = getWgStats();
+      if (isSystemWide) {
+        const stats = getWgStats(info.mode === 'amneziawg');
         if (stats) {
           dataUsage = `${formatBytes(stats.totalRx)} / ${formatBytes(stats.totalTx)}`;
         }
@@ -128,8 +133,16 @@ export default async (options) => {
       table.push(
         ['Status', chalk.green('Connected')],
         ['Mode', (info.mode || 'ssh').toUpperCase()],
-        ['Server', info.server],
-        ['Proxy', `socks5://127.0.0.1:${info.port}`],
+        ['Server', info.server]
+      );
+
+      if (isSystemWide) {
+        table.push(['Connection', chalk.cyan('System-wide (All OS traffic)')]);
+      } else {
+        table.push(['Proxy', `socks5://127.0.0.1:${info.port}`]);
+      }
+
+      table.push(
         ['Current IP', chalk.cyan(currentIp)],
         ['Uptime', `${uptimeMin} minutes`],
         ['PID', info.pid.toString()]

package/src/commands/tui.js

@@ -87,8 +87,12 @@ const fmtBytes = (n) => {
   return `${(n / Math.pow(k, i)).toFixed(1)} ${s[i]}`;
 };
 
-const wgStats = () => {
-  const r = spawnSync('sudo', ['wg', 'show', 'all', 'dump'], { encoding: 'utf-8' });
+const wgStats = (isAwg = false) => {
+  const cmd = isAwg ? 'awg' : 'wg';
+  let r = spawnSync('sudo', [cmd, 'show', 'all', 'dump'], { encoding: 'utf-8' });
+  if (r.status !== 0 && isAwg) {
+    r = spawnSync('sudo', ['wg', 'show', 'all', 'dump'], { encoding: 'utf-8' });
+  }
   if (r.status !== 0) return null;
   const lines = r.stdout.trim().split('\n');
   if (lines.length <= 1) return null;
@@ -293,7 +297,7 @@ export default async () => {
     if (info) {
       const upMin = Math.floor((Date.now() - new Date(info.startTime).getTime()) / 60000);
       const ping  = pingServer(info.server.split('@').pop());
-      const wg    = wgStats();
+      const wg    = wgStats(info.mode === 'amneziawg');
       L.push(`${t(D.accent, b('◈  Tunnel Status'))}    ${t(D.success, '⬤  ACTIVE')}`);
       L.push(hr()); L.push('');
       L.push(`  ${mu('Server  ')}  ${b(info.server)}`);
@@ -391,7 +395,13 @@ export default async () => {
   const renderPeers = () => {
     const L = [];
     L.push(`${t(D.accent, b('≡  WireGuard Peers'))}`); L.push(hr()); L.push('');
-    const r = spawnSync('sudo', ['wg', 'show', 'all', 'dump'], { encoding: 'utf-8' });
+    const info = getActiveTunnel();
+    const isAwg = info && info.mode === 'amneziawg';
+    const cmd = isAwg ? 'awg' : 'wg';
+    let r = spawnSync('sudo', [cmd, 'show', 'all', 'dump'], { encoding: 'utf-8' });
+    if (r.status !== 0 && isAwg) {
+      r = spawnSync('sudo', ['wg', 'show', 'all', 'dump'], { encoding: 'utf-8' });
+    }
     if (r.status !== 0 || !r.stdout.trim()) {
       L.push(`  ${t(D.warning, '⚠')}  No WireGuard interface found.`);
       L.push(`  ${mu('Start a WireGuard tunnel first.')}`);