neosh 0.0.0 → 0.3.0

package/README.md

@@ -1,29 +1,46 @@
 # neosh
 
-This npm package is a **name reservation**. It installs nothing.
+**Neovim for controlling AI agents.** A terminal workspace where every feature is a plugin.
 
-neosh is a terminal-first agent workspace, and it is a Rust binary rather than a Node program.
-Install it one of these ways:
+```sh
+npm install -g neosh
+neosh
+```
+
+No API key needed to start — an existing `claude` login works as is.
+
+This package is a launcher. The binary itself arrives as one of four platform packages
+(`@neosh/cli-darwin-arm64` and siblings), and npm installs only the one that runs on your machine.
+There is no `postinstall` download, so `--ignore-scripts` and offline caches both work.
+
+macOS and Linux only: the workspace talks to its terminals over a Unix socket, so there is nothing
+to ship for Windows yet.
+
+## Other ways in
 
 ```sh
 brew install neoswarm/tap/neosh          # macOS and Linux
 cargo install neosh                      # from source, needs a Rust toolchain
+curl -fsSL https://neoswarm.dev/install.sh | sh
 ```
 
-…or take a prebuilt binary from [the releases page](https://github.com/neoswarm/neosh/releases).
+Prebuilt binaries are on [the releases page](https://github.com/neoswarm/neosh/releases).
 
-The npm packages that *are* real are the plugin ones — `@neosh/api` is what a plugin author writes
-against:
+## What it is
 
-```sh
-npm install --save-dev @neosh/api
-```
+The workspace is a process and your terminals are viewers of it. Each terminal is somewhere in the
+workspace — its own conversation, scroll and panels — while the turns are shared, so closing one
+does not stop the work and `neosh` puts you back where you were.
+
+The thesis is that extensibility is the product: every capability ships on the same public API a
+third-party plugin author would use, and the sidebar, the model switcher, the palette, git and the
+approval prompts are all ordinary plugins written against exactly that surface. If you can see it,
+a plugin can replace it.
+
+Writing one starts with [`@neosh/api`](https://www.npmjs.com/package/@neosh/api).
 
-Everything else lives at <https://github.com/neoswarm/neosh>.
+Documentation: <https://github.com/neoswarm/neosh>.
 
-## Why is this here?
+## Licence
 
-Two reasons. It keeps the name pointing at the real project rather than at whatever someone else
-publishes under it. And npm cannot attach a trusted publisher to a package that does not exist yet,
-so a package has to be created before its releases can be tokenless — this one is created and then
-left alone.
+MIT.

package/bin/neosh.js

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+"use strict";
+
+// The binary lives in a platform package — `@neosh/cli-darwin-arm64` and its three siblings — each
+// declaring `os` and `cpu`, so npm installs exactly the one that runs here and skips the rest. This
+// file is the `bin` npm puts on PATH, and all it does is find that binary and become it.
+//
+// No `postinstall` download, deliberately: a script that fetches at install time fails closed under
+// `--ignore-scripts`, which is the default in an increasing number of CI setups and the first thing
+// a security review turns on. An optional dependency is resolved by npm itself, offline caches
+// work, and a lockfile pins the binary the way it pins everything else.
+
+const { spawn } = require("node:child_process");
+
+const TARGETS = {
+  "darwin arm64": "@neosh/cli-darwin-arm64",
+  "darwin x64": "@neosh/cli-darwin-x64",
+  "linux x64": "@neosh/cli-linux-x64",
+  "linux arm64": "@neosh/cli-linux-arm64",
+};
+
+const key = `${process.platform} ${process.arch}`;
+const pkg = TARGETS[key];
+
+if (!pkg) {
+  // Windows lands here, and says why rather than looking broken: the workspace talks to its
+  // terminals over a Unix socket, so there is no binary to have installed.
+  const what = process.platform === "win32" ? "Windows" : key;
+  console.error(`neosh: no prebuilt binary for ${what}.`);
+  console.error("neosh runs on macOS and Linux. See https://github.com/neoswarm/neosh");
+  process.exit(1);
+}
+
+let binary;
+try {
+  binary = require.resolve(`${pkg}/bin/neosh`);
+} catch {
+  // npm skips an optional dependency whose install failed and carries on, so a missing platform
+  // package is an ordinary outcome rather than an impossible one — and the fix is a command.
+  console.error(`neosh: the ${pkg} package is missing.`);
+  console.error("Reinstall with `npm install -g neosh`, or take a binary from");
+  console.error("https://github.com/neoswarm/neosh/releases");
+  process.exit(1);
+}
+
+// `spawn` with inherited stdio rather than `spawnSync`: neosh is a full-screen terminal program
+// that wants the tty, and it has signals to receive — `^C` has to reach the agent, not this shim.
+const child = spawn(binary, process.argv.slice(2), { stdio: "inherit" });
+
+// Forward the signals a terminal sends, so `^C` and a `kill` both land on the real process. The
+// shim staying alive until the child is gone is what makes `neosh` in a script behave like neosh.
+for (const signal of ["SIGINT", "SIGTERM", "SIGHUP", "SIGQUIT"]) {
+  process.on(signal, () => child.kill(signal));
+}
+
+child.on("error", (err) => {
+  console.error(`neosh: could not start ${binary}: ${err.message}`);
+  process.exit(1);
+});
+
+child.on("exit", (code, signal) => {
+  // A process killed by a signal did not exit with a code, and reporting 0 there would tell a
+  // shell the run succeeded. 128 + n is what a shell reports for exactly this.
+  if (signal) process.exit(128 + (require("node:os").constants.signals[signal] ?? 0));
+  process.exit(code ?? 0);
+});

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "neosh",
-  "version": "0.0.0",
-  "description": "Reserved for neosh, a terminal-first agent workspace. neosh is a Rust binary \u2014 install it from https://github.com/neoswarm/neosh/releases, `brew install neoswarm/tap/neosh`, or `cargo install neosh`. This package is a name reservation and installs nothing.",
+  "version": "0.3.0",
+  "description": "Neovim for controlling AI agents. A terminal workspace where every feature is a plugin.",
   "license": "MIT",
+  "bin": {
+    "neosh": "bin/neosh.js"
+  },
   "keywords": [
-    "neosh"
+    "neosh",
+    "agent",
+    "tui",
+    "ai",
+    "terminal"
   ],
   "homepage": "https://github.com/neoswarm/neosh",
   "repository": {
@@ -12,7 +19,22 @@
     "url": "git+https://github.com/neoswarm/neosh.git",
     "directory": "npm/neosh"
   },
+  "engines": {
+    "node": ">=18"
+  },
+  "os": [
+    "darwin",
+    "linux"
+  ],
   "files": [
-    "README.md"
-  ]
+    "bin",
+    "README.md",
+    "!._*"
+  ],
+  "optionalDependencies": {
+    "@neosh/cli-darwin-arm64": "0.3.0",
+    "@neosh/cli-darwin-x64": "0.3.0",
+    "@neosh/cli-linux-x64": "0.3.0",
+    "@neosh/cli-linux-arm64": "0.3.0"
+  }
 }