deskssh 0.0.2 → 0.1.0

package/README.md

@@ -4,8 +4,34 @@
 every action is translated into commands executed on the remote host. _Not remote
 desktop. Agentless._
 
-> ⚠️ **Early development — not yet functional.** This `0.0.1` reserves the package
-> name and provides the future `deskssh` launch command. Follow progress on GitHub.
+## Run it
+
+DeskSSH runs on **your** machine and connects to **your** servers. No install:
+
+```bash
+npx deskssh
+```
+
+…or install it globally:
+
+```bash
+npm install -g deskssh
+deskssh
+```
+
+This starts DeskSSH on `http://127.0.0.1:8717` and opens your browser. Enter a
+server's host, port, user and a password or private key, and you get a familiar
+desktop — file manager, terminal, text editor (Stallman), system monitor — all
+over plain SSH.
+
+> It binds to `127.0.0.1` by default (it is an SSH gateway and should not be
+> exposed by accident). Override with `HOST` / `PORT` env vars if you know what
+> you're doing.
+
+Requirements: **Node.js >= 20**. Remote host: a Linux server with SSH
+(Debian/Ubuntu/Mint in v1).
+
+## Links
 
 - Repository & docs: https://github.com/nestorrguez/DeskSSH
 - License: **AGPL-3.0-or-later**

package/bin/deskssh.js

@@ -1,12 +1,36 @@
 #!/usr/bin/env node
-// DeskSSH CLI — placeholder for the self-hosted (npm) distribution.
-// DeskSSH is in early development and not yet functional; this entry exists to
-// reserve the package name and provide the future `deskssh` launch command.
+// DeskSSH launcher. Starts the gateway (which also serves the web UI) on
+// 127.0.0.1 and opens the browser. DeskSSH runs on *your* machine and connects to
+// *your* servers; it binds to localhost so it is never exposed by accident.
 
-console.log(`DeskSSH 0.0.1 — early development, not yet functional.
+import { spawn } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+import { dirname, join } from 'node:path';
+import { startGateway } from '../dist/server.js';
 
-A graphical desktop over plain SSH: the GUI is synthesized client-side and
-every action maps to remote commands. Not remote desktop. Agentless.
+const here = dirname(fileURLToPath(import.meta.url));
+const staticDir = join(here, '..', 'dist', 'web');
 
-Follow progress: https://github.com/nestorrguez/DeskSSH
-`);
+const port = Number(process.env.PORT ?? 8717);
+const host = process.env.HOST ?? '127.0.0.1';
+const url = `http://${host}:${port}`;
+
+startGateway({ port, host, staticDir });
+
+console.log(`\n  DeskSSH is running at ${url}\n  Press Ctrl+C to stop.\n`);
+
+if (process.env.DESKSSH_NO_OPEN !== '1') openBrowser(url);
+
+function openBrowser(target) {
+  const cmd =
+    process.platform === 'darwin' ? 'open' : process.platform === 'win32' ? 'start' : 'xdg-open';
+  try {
+    spawn(cmd, [target], {
+      stdio: 'ignore',
+      detached: true,
+      shell: process.platform === 'win32',
+    }).unref();
+  } catch {
+    // Opening the browser is best-effort; the URL is printed above.
+  }
+}