deskssh 0.0.1 → 0.1.0

package/README.md

@@ -1,66 +1,37 @@
-<h1 align="center">DeskSSH</h1>
+# DeskSSH
 
-<p align="center">
-  <strong>A graphical desktop over plain SSH.</strong><br>
-  The GUI is synthesized on the client; every action is translated into commands
-  executed on the remote host. <em>It is not remote desktop.</em>
-</p>
+**A graphical desktop over plain SSH.** The GUI is synthesized on the client and
+every action is translated into commands executed on the remote host. _Not remote
+desktop. Agentless._
 
----
+## Run it
 
-## What is it?
+DeskSSH runs on **your** machine and connects to **your** servers. No install:
 
-You connect via SSH to a server **with no graphical environment** and DeskSSH
-shows you a familiar desktop —file manager, terminal, system monitor, editor,
-service manager…—. Behind the scenes, every click runs the equivalent command
-(`ls`, `stat`, `mv`, `systemctl`, `ps`…) and the interface is built from its
-output.
+```bash
+npx deskssh
+```
 
-### What makes it different
+…or install it globally:
 
-- **Not VNC/RDP/X.** No pixels travel: the GUI is generated locally.
-- **Agentless.** Installs nothing on the server; only needs SSH and standard POSIX
-  utilities.
-- **Transparent.** You can always see the command behind each action.
-- **100% open source.**
+```bash
+npm install -g deskssh
+deskssh
+```
 
-## Origin and motivation
+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.
 
-DeskSSH started as a project in **ASP.NET with .NET 8**. As it grew, I felt
-overwhelmed by the sheer number of commands and cases the tool could end up
-covering. I began reviewing and improving the code with the help of AI, but ended
-up making a more radical decision: **restart the project from scratch**, also with
-AI, in order to:
+> 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.
 
-- use languages and technologies **more widely accepted by the community**, and
-- leverage **npm's ease of distribution** for simple adoption.
+Requirements: **Node.js >= 20**. Remote host: a Linux server with SSH
+(Debian/Ubuntu/Mint in v1).
 
-This rewrite is developed with **Spec-Driven Development**: decisions are
-documented in `specs/` before any code is written.
+## Links
 
-The reason for making it **open source** is simple: I want DeskSSH to become a
-**genuinely useful and popular** tool, built and improved by the community.
-
-## Status
-
-🚧 **In design.** The project is developed with **Spec-Driven Development**: right
-now only the specification exists; code comes later. Start with:
-
-- [`specs/vision.md`](specs/vision.md) — the why and the where-to (the vision).
-- [`specs/constitution.md`](specs/constitution.md) — the project's principles.
-- [`specs/001-core/spec.md`](specs/001-core/spec.md) — what DeskSSH does.
-- [`specs/001-core/plan.md`](specs/001-core/plan.md) — how it will be built.
-- [`specs/glossary.md`](specs/glossary.md) — the domain vocabulary.
-
-## How to contribute
-
-This project follows SDD: design discussions happen in `specs/` **before** they
-reach the code. To propose something, open the conversation on the relevant
-document. (Detailed contribution guide: pending — `M0`.)
-
-## License
-
-[**GNU AGPL-3.0-or-later**](LICENSE). Strong copyleft with a network clause: if you
-modify DeskSSH and offer it as a network-accessible service, you must publish your
-changes. Chosen so the project and all its improvements stay free. See
-[`specs/constitution.md`](specs/constitution.md), Article 9.
+- Repository & docs: https://github.com/nestorrguez/DeskSSH
+- License: **AGPL-3.0-or-later**

package/bin/deskssh.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+// 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.
+
+import { spawn } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+import { dirname, join } from 'node:path';
+import { startGateway } from '../dist/server.js';
+
+const here = dirname(fileURLToPath(import.meta.url));
+const staticDir = join(here, '..', 'dist', 'web');
+
+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.
+  }
+}