windscout 0.5.0 → 0.5.2

package/README.md

@@ -59,7 +59,7 @@ Run `windscout` with no arguments to open the interactive picker:
 
 Your selection is saved to `~/.config/windscout/config.json` (`%USERPROFILE%\.config\windscout\config.json` on Windows) and preselected next time.
 
-While scanning, WindScout shows a progress bar, elapsed time and remaining time. It also shows what it's doing right now (connecting, measuring latency or measuring speed). The table of working locations refreshes after each country. When the scan finishes, the final report is printed to your normal terminal.
+While scanning, WindScout shows a progress bar, elapsed time and remaining time. It also shows what it's doing right now (connecting, measuring latency or measuring speed). The table of working locations refreshes after each country. When the scan finishes, the final report is printed to your normal terminal. It ends with the best connection and the other working ones, each with its `windscribe-cli connect` command; type a number at the prompt to connect to it.
 
 ### Non-interactive
 
@@ -75,7 +75,7 @@ windscout -t 40 -a                          # longer connect timeout, also list
 |---|---|---|
 | `-c, --countries` | comma-separated ISO country codes, city names or nicknames | open the picker |
 | `-p, --protocols` | comma-separated: `wireguard`, `ikev2` (macOS and Windows), `stealth`, `wstunnel`, `udp`, `tcp`, optionally `:port` | saved, or all |
-| `-t, --timeout` | seconds to wait for each connection | 20 |
+| `-t, --timeout` | seconds to wait for each connection, at least 10 | picker: saved, or 20; with `-c`: 20 |
 | `-a, --all` | include failed attempts in the final table | off |
 | `-n, --no-speed` | connect-only mode: skip the download test, rank by latency | picker: saved, or connect-only on first run; with `-c`: speed test on |
 | `-f, --firewall` | block internet while scanning, except through the VPN | picker: saved, or off; with `-c`: off |

package/dist/cli.js

@@ -2,16 +2,18 @@
 // WindScout: find which Windscribe locations and protocols actually work from here.
 // Drives the official windscribe-cli: connects to each country/protocol pair,
 // measures latency and download speed through the tunnel, prints a ranked table.
+import { createInterface } from "node:readline";
 import { parseArgs } from "node:util";
-import { CONFIG, loadConfig } from "./config.js";
+import { CONFIG, DEFAULT_TIMEOUT, loadConfig, MIN_TIMEOUT } from "./config.js";
 import { Scan } from "./scan.js";
 import { pick } from "./tui/picker.js";
 import { logProgress, showProgress } from "./tui/progress.js";
-import { report } from "./tui/report.js";
+import { command, report, target } from "./tui/report.js";
 import { leaveScreen, out } from "./tui/terminal.js";
-import { yellow } from "./tui/text.js";
+import { cyan, green, yellow } from "./tui/text.js";
+import { now, sleep } from "./time.js";
 import { checkUpdate, updateNotice, VERSION } from "./update.js";
-import { blockInternet, CLI, isFirewallOn, PROTOCOLS, restoreFirewall, waitForLogin } from "./windscribe.js";
+import { blockInternet, CLI, connectState, isFirewallOn, PROTOCOLS, restoreFirewall, waitForLogin, windscribe } from "./windscribe.js";
 const HELP = `Usage: windscout [options]
 
 Find which Windscribe locations and protocols work from your network, ranked by speed.
@@ -20,7 +22,7 @@ Without -c it opens an interactive country picker (your selection is remembered)
 Options:
   -c, --countries LIST  comma-separated ISO codes, city names or nicknames (skips the picker)
   -p, --protocols LIST  comma-separated protocols, optional :port (default: ${PROTOCOLS.join(",")})
-  -t, --timeout SEC     seconds to wait for each connection (default: 20)
+  -t, --timeout SEC     seconds to wait for each connection, at least ${MIN_TIMEOUT} (default: saved, or ${DEFAULT_TIMEOUT})
   -a, --all             also show failed attempts in the final table
   -n, --no-speed        connect-only: skip the download test, rank by latency (faster scan)
   -f, --firewall        block internet while scanning, except through the VPN (turned back off afterwards)
@@ -31,12 +33,39 @@ Selection is stored in ${CONFIG}
 Example: windscout -c DE,NL,TR -p stealth,tcp:443`;
 // "DE, NL,,TR" → ["DE", "NL", "TR"]
 const list = (s) => s.split(",").map((x) => x.trim()).filter(Boolean);
+const ask = (question) => new Promise((resolve) => {
+    const rl = createInterface({ input: process.stdin, output: out });
+    rl.on("SIGINT", () => rl.close()); // Ctrl-C / Ctrl-D: same as enter
+    rl.on("close", () => resolve(""));
+    rl.question(question, (a) => (resolve(a.trim()), rl.close()));
+});
+/** Asks which numbered connection to make, then runs its command and waits for it to connect */
+async function offerConnect(choices, timeout) {
+    const others = choices.length > 1 ? `, 1-${choices.length - 1} = other` : "";
+    for (;;) {
+        const a = await ask(`\nconnect to # (0 = best${others}, enter to quit): `);
+        if (!a)
+            return;
+        const r = /^\d+$/.test(a) ? choices[Number(a)] : undefined;
+        if (!r) {
+            console.log(yellow(`no #${a} in the tables`));
+            continue;
+        }
+        console.log(cyan(command(r)));
+        await windscribe("connect", target(r), r.protocol);
+        let state = "";
+        for (const t = now(); now() - t < timeout && !(state = await connectState()).startsWith("Connected");)
+            await sleep(1000);
+        console.log(state.startsWith("Connected") ? green(state) : yellow(`${state || "not connected"} after ${timeout} s`));
+        return;
+    }
+}
 async function main() {
     const { values: a } = parseArgs({
         options: {
             countries: { type: "string", short: "c" },
             protocols: { type: "string", short: "p" },
-            timeout: { type: "string", short: "t", default: "20" },
+            timeout: { type: "string", short: "t" },
             all: { type: "boolean", short: "a", default: false },
             help: { type: "boolean", short: "h", default: false },
             version: { type: "boolean", short: "v", default: false },
@@ -55,9 +84,9 @@ async function main() {
             console.error(yellow(notice));
         return;
     }
-    const timeout = Number(a.timeout);
-    if (!(timeout > 0))
-        throw new Error("--timeout must be a positive number");
+    let timeout = a.timeout ? Number(a.timeout) : undefined;
+    if (timeout !== undefined && !(timeout >= MIN_TIMEOUT))
+        throw new Error(`--timeout must be at least ${MIN_TIMEOUT} seconds`);
     const status = await waitForLogin();
     const tty = Boolean(process.stdin.isTTY && out.isTTY);
     let countries = a.countries ? list(a.countries) : undefined;
@@ -71,7 +100,7 @@ async function main() {
         if (protocols && saved)
             saved.protocols = protocols.filter((p) => PROTOCOLS.includes(p));
         const choice = await pick(saved, {
-            timeout,
+            timeout: timeout ?? saved?.timeout ?? DEFAULT_TIMEOUT,
             speedTest: speedTest && (saved?.speed ?? false), // first run: connect-only
             // already on in the app: show it on, since the scan won't turn it off
             firewall: firewall || isFirewallOn(status) || (saved?.firewall ?? false),
@@ -82,8 +111,10 @@ async function main() {
         protocols ??= choice.protocols;
         speedTest = choice.speed;
         firewall = choice.firewall;
+        timeout = choice.timeout;
     }
     protocols ??= PROTOCOLS;
+    timeout ??= DEFAULT_TIMEOUT;
     const scan = new Scan(countries, protocols, { timeout, speedTest });
     const blocking = firewall && (await blockInternet());
     const view = tty ? showProgress(scan, blocking) : logProgress(scan);
@@ -92,11 +123,13 @@ async function main() {
     view.close();
     if (scan.stopping)
         console.log(yellow("interrupted, showing partial results"));
-    report(scan.results, protocols, { all: a.all, speedTest });
+    const choices = report(scan.results, protocols, { all: a.all, speedTest });
     await checkUpdate();
     const notice = updateNotice();
     if (notice)
         console.error("\n" + yellow(notice));
+    if (tty && choices.length)
+        await offerConnect(choices, timeout);
 }
 main().catch(async (e) => {
     leaveScreen();

package/dist/config.js

@@ -3,6 +3,8 @@ import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { homedir } from "node:os";
 import { dirname, join } from "node:path";
 import { COUNTRIES, PROTOCOLS } from "./windscribe.js";
+export const DEFAULT_TIMEOUT = 20;
+export const MIN_TIMEOUT = 10; // seconds; shorter cuts off connections that would have worked
 export const CONFIG = join(process.env.XDG_CONFIG_HOME || join(homedir(), ".config"), "windscout", "config.json");
 /** The saved choice, minus anything this version doesn't offer; null on first run or an unreadable file */
 export function loadConfig() {
@@ -13,6 +15,7 @@ export function loadConfig() {
             protocols: (c.protocols ?? []).filter((x) => PROTOCOLS.includes(x)),
             speed: c.speed !== false,
             firewall: c.firewall === true,
+            timeout: c.timeout >= MIN_TIMEOUT ? c.timeout : DEFAULT_TIMEOUT,
         };
     }
     catch {

package/dist/tui/picker.js

@@ -1,4 +1,4 @@
-import { saveConfig } from "../config.js";
+import { MIN_TIMEOUT, saveConfig } from "../config.js";
 import { attemptSeconds, estimate } from "../scan.js";
 import { duration } from "../time.js";
 import { checkUpdate, updateNotice } from "../update.js";
@@ -13,6 +13,7 @@ export function pick(saved, { timeout, speedTest, firewall }) {
     const selected = new Set(saved?.countries ?? []);
     const protos = new Set(saved?.protocols.length ? saved.protocols : PROTOCOLS);
     let cursor = 0, top = 0, message = "", query = "", searching = false;
+    let seconds = String(timeout), editing = false; // the timeout, as typed
     let hit;
     const visible = () => {
         const q = query.toLowerCase();
@@ -24,7 +25,7 @@ export function pick(saved, { timeout, speedTest, firewall }) {
             const rows = out.rows || 24;
             const notice = updateNotice();
             const matches = visible();
-            const height = Math.max(3, rows - 20 - (notice ? 1 : 0));
+            const height = Math.max(3, rows - 21 - (notice ? 1 : 0));
             cursor = Math.max(0, Math.min(cursor, matches.length - 1));
             if (cursor < top)
                 top = cursor;
@@ -39,6 +40,9 @@ export function pick(saved, { timeout, speedTest, firewall }) {
             const fwLine = `${dim(under("f"))} ${firewall ? green("● " + fwLabel) : dim("○ " + fwLabel)}  ${dim(firewall
                 ? "only VPN traffic gets through"
                 : "off: apps may leak in between")}`;
+            timeout = Number(seconds);
+            const short = timeout < MIN_TIMEOUT;
+            const timeoutLine = `${dim(under("t"))} timeout ${editing ? bold(seconds) + cyan("▏") : (short ? yellow : bold)(seconds || "?")} s  ${dim(`per connection · at least ${MIN_TIMEOUT}`)}`;
             const search = searching
                 ? `${cyan("🔍")} ${bold(query)}${cyan("▏")}`
                 : query ? `🔍 ${query}` : dim("🔍 press / to search");
@@ -59,9 +63,9 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 ["quit", under("Q") + "uit"],
             ];
             const buttonLine = buttons.map(([id, label]) => (id === "start" ? bold(cyan(`[ ${label} ]`)) : dim(`[ ${label} ]`))).join("  ");
-            const table = grid([{ title: "" }, { title: "Code" }, { title: "Country" }], body, { caption: search, captionRight: dim(range), minWidth: Math.max(vw(protoLine), vw(speedLine), vw(fwLine)) + 4 });
+            const table = grid([{ title: "" }, { title: "Code" }, { title: "Country" }], body, { caption: search, captionRight: dim(range), minWidth: Math.max(vw(protoLine), vw(speedLine), vw(fwLine), vw(timeoutLine)) + 4 });
             const width = vw(table[0]);
-            const head = box([protoLine, speedLine, fwLine], {
+            const head = box([protoLine, speedLine, fwLine, timeoutLine], {
                 title: bold(cyan("WindScout")),
                 right: `${bold(String(selected.size))}${dim(`/${COUNTRIES.length} selected`)}`,
                 width: width - 4,
@@ -76,10 +80,12 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 centerIn(n
                     ? `${bold(String(n))} attempts · estimated ${bold("≈ " + duration(estimate(selected.size, protos.size, timeout)))} ${dim(`(~${attemptSeconds(timeout)}s each)`)}`
                     : yellow("select at least one country and one protocol"), width),
-                centerIn(dim(searching
-                    ? "type to filter · ↑↓ move · enter/esc done"
-                    : `↑↓ move · space select · a/n ${query ? "all/none shown" : "all/none"} · / search`), width),
-                centerIn(dim(searching ? "" : `1-${PROTOCOLS.length} protocols · s speed test · f firewall · enter start · ${query ? "esc clear · " : ""}q quit`), width),
+                centerIn(dim(editing
+                    ? "type the seconds to wait for each connection · enter/esc done"
+                    : searching
+                        ? "type to filter · ↑↓ move · enter/esc done"
+                        : `↑↓ move · space select · a/n ${query ? "all/none shown" : "all/none"} · / search`), width),
+                centerIn(dim(searching || editing ? "" : `1-${PROTOCOLS.length} protocols · s speed test · f firewall · t timeout · enter start · ${query ? "esc clear · " : ""}q quit`), width),
             ];
             if (message)
                 lines.push(centerIn(yellow(message), width));
@@ -103,7 +109,7 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 return range;
             });
             hit = {
-                protoRow: at.top + 1, protoHits, speedRow: at.top + 2, firewallRow: at.top + 3,
+                protoRow: at.top + 1, protoHits, speedRow: at.top + 2, firewallRow: at.top + 3, timeoutRow: at.top + 4,
                 searchRow: at.top + head.length + 1,
                 firstRow: at.top + head.length + 5, shown: shown.length,
                 buttonRow: at.top + head.length + table.length + 1, buttonHits,
@@ -125,12 +131,17 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 message = "nothing to scan yet";
                 return false;
             }
+            if (!(timeout >= MIN_TIMEOUT)) {
+                message = `the timeout must be at least ${MIN_TIMEOUT} seconds`;
+                return false;
+            }
             // keep the user's order of preference stable: list order
             const choice = {
                 countries: COUNTRIES.filter((c) => selected.has(c)),
                 protocols: PROTOCOLS.filter((p) => protos.has(p)),
                 speed: speedTest,
                 firewall,
+                timeout,
             };
             saveConfig(choice);
             finish(choice);
@@ -149,9 +160,11 @@ export function pick(saved, { timeout, speedTest, firewall }) {
             else if (m.button !== 0)
                 return; // left button only
             else if (y === hit.searchRow)
-                searching = true;
+                searching = true, editing = false;
+            else if (y === hit.timeoutRow)
+                editing = true, searching = false;
             else {
-                searching = false; // clicking anywhere else ends typing, like leaving a text field
+                searching = editing = false; // clicking anywhere else ends typing, like leaving a text field
                 if (y >= hit.firstRow && y < hit.firstRow + hit.shown) {
                     cursor = top + (y - hit.firstRow);
                     const c = matches[cursor];
@@ -203,6 +216,14 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 cursor = Math.max(0, cursor - 10);
             else if (k === "pagedown")
                 cursor = Math.min(matches.length - 1, cursor + 10);
+            else if (editing) {
+                if (k === "return" || k === "escape")
+                    editing = false;
+                else if (k === "backspace")
+                    seconds = seconds.slice(0, -1);
+                else if (/^[0-9]$/.test(str ?? "") && seconds.length < 4)
+                    seconds = seconds === "0" ? str : seconds + str;
+            }
             else if (searching) {
                 // typing goes into the search box; letters are not shortcuts here
                 if (k === "return" || k === "escape")
@@ -234,6 +255,8 @@ export function pick(saved, { timeout, speedTest, firewall }) {
                 speedTest = !speedTest;
             else if (k === "f")
                 firewall = !firewall;
+            else if (k === "t")
+                editing = true, seconds = "";
             else if (/^[1-9]$/.test(str ?? "") && PROTOCOLS[Number(str) - 1])
                 flip(protos, PROTOCOLS[Number(str) - 1]);
             else if (k === "escape" && query)

package/dist/tui/report.js

@@ -5,26 +5,35 @@ import { flag } from "./country.js";
 import { matrix, resultTable } from "./tables.js";
 import { bold, cyan, dim, fmt, green, vw, yellow } from "./text.js";
 import { box, grid } from "./widgets.js";
+// nickname pins the exact datacenter
+export const target = (r) => r.location.split(" - ").at(-1) || r.query;
+export const command = (r) => `${CLI} connect "${target(r)}" ${r.protocol}`;
+/** Prints the report; returns the connections it numbered: the best (#0), then the others (#1…) */
 export function report(results, protocols, { all, speedTest }) {
     const ok = sortOk(results);
     const rows = [...ok, ...(all ? results.filter((r) => r.status !== "ok") : [])];
+    const others = ok.slice(1).sort((x, y) => (x.latencyMs ?? Infinity) - (y.latencyMs ?? Infinity));
     // render once to learn the widest table, then again so every box lines up
     const build = (minWidth) => ({
         avail: matrix(results, protocols, { minWidth }),
         main: rows.length
             ? resultTable(rows, speedTest, { caption: bold("Results"), captionRight: dim(`${ok.length} working`), minWidth })
             : [],
+        others: others.length
+            ? grid([{ title: "#", align: "right" }, { title: "Location" }, { title: "Protocol" }, { title: "Latency", align: "right" }, { title: "Connect with" }], others.map((r, i) => [dim(String(i + 1)), `${flag(r.query)} ${r.location}`, r.protocol,
+                r.latencyMs === null ? "-" : `${fmt(r.latencyMs, 0)} ms`, cyan(command(r))]), { caption: bold("Other working locations"), captionRight: dim("by latency"), minWidth })
+            : [],
     });
     const first = build(0);
-    const width = Math.max(64, ...[first.avail[0], first.main[0]].filter(Boolean).map(vw));
-    const { avail, main } = build(width);
+    const width = Math.max(64, ...[first.avail[0], first.main[0], first.others[0]].filter(Boolean).map(vw));
+    const { avail, main, others: rest } = build(width);
     console.log();
     if (avail.length)
         console.log(avail.join("\n"));
     if (!ok.length) {
         console.log(box([yellow("Nothing connected."),
             dim("Try other countries, ports (e.g. -p stealth:443,tcp:443) or a longer --timeout.")], { title: bold(cyan("WindScout")), width: width - 4 }).join("\n"));
-        return;
+        return [];
     }
     console.log(main.join("\n"));
     const stats = protocols.map((p) => {
@@ -35,10 +44,12 @@ export function report(results, protocols, { all, speedTest }) {
     const bestValue = (r) => (speedTest ? `${fmt(r.speedMbps, 1)} Mbps` : `${fmt(r.latencyMs, 0)} ms`);
     console.log(grid([{ title: "Protocol" }, { title: "Worked", align: "right" }, { title: speedTest ? "Best speed" : "Best latency", align: "right" }, { title: "Best location" }], stats.map((s) => [s.p, `${s.good}/${s.tried}`, s.best ? bestValue(s.best) : "-", s.best ? `${flag(s.best.query)} ${s.best.location}` : "-"]), { caption: bold("Per protocol"), minWidth: width }).join("\n"));
     const b = ok[0];
-    const target = b.location.split(" - ").at(-1) || b.query; // nickname pins the exact datacenter
     const facts = [speedTest && `${fmt(b.speedMbps, 1)} Mbps`, `${fmt(b.latencyMs, 0)} ms`].filter(Boolean).join(" · ");
     console.log(box([
         `${flag(b.query)} ${bold(b.location)} over ${bold(b.protocol)} ${dim("· " + facts)}`,
-        cyan(`${CLI} connect "${target}" ${b.protocol}`),
+        cyan(command(b)),
     ], { title: green(speedTest ? "★ Best" : "★ Best (lowest latency)"), width: width - 4 }).join("\n"));
+    if (rest.length)
+        console.log(rest.join("\n"));
+    return [b, ...others];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "windscout",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "Find which Windscribe locations and protocols work from your network, ranked by speed (unofficial)",
   "type": "module",
   "bin": {