@awebai/oats 0.30.3 → 0.32.0

package/docs/servers.md

@@ -26,13 +26,59 @@ oats server remove build
 - `--path` prepends directories to the minimal remote PATH of every routed
   command (`~/.local/bin:/opt/pi/bin`), where the remote spawn looks for the
   harness binary.
-- `--herdr` records the remote Herdr path in the registration and in each
-  saved route. Routed commands do not pass it on; the remote kernel finds
-  `herdr` on its own PATH.
+- `--herdr` is refused (`E_HERDR_REMOVED`): Herdr was removed in 0.31.0. A
+  registration or saved route that still records `herdrPath` loads; the field
+  is ignored, never written or printed.
 - `--label` sets a display name. `--replace` overwrites an existing id.
 - Registrations live in `~/.oats/servers.json` on this machine, never in a
   repository.
 
+## Connections
+
+Every routed ssh call carries these options, before `--` and the host:
+
+| Option | Why |
+|---|---|
+| `BatchMode=yes`, `ConnectTimeout=15` | a prompt or an unreachable host fails fast |
+| `ServerAliveInterval=15`, `ServerAliveCountMax=3` | a link that died without a reset ends the call, an attached viewer included, within about 60 s |
+| `ControlMaster=auto`, `ControlPath=~/.oats/ssh/%C`, `ControlPersist=60` | every call to one host (the probe, the command, a viewer, concurrent Desktop reads) shares one authenticated connection, kept 60 s after its last client |
+
+- Options given with `-o` override `~/.ssh/config`, so these replace any
+  `ControlMaster`, `ControlPath` or `ControlPersist` set there for the host.
+  Everything else in your ssh config (users, keys, `ProxyJump`, host
+  verification) applies as usual; a `ProxyJump` host is reached once per
+  master.
+- `~/.oats/ssh` (under `OATS_HOME_DIR` when set) is created mode 0700. OATS
+  does not use it if it is owned by another user or writable by group or
+  others.
+- ssh binds the control socket at the path plus 17 bytes, within the 104-byte
+  socket path limit of macOS, so the directory path may be at most 45 bytes.
+  `/Users/<name>/.oats/ssh` fits for any name up to 23 characters. The path
+  must also be one ssh reads literally: letters, digits and `. _ / + , : @ =
+  -` only (a space, `%`, `$`, a quote or `#` is ssh syntax).
+- When the path does not fit, has other characters, or the directory is not
+  private, calls run with `ControlPath=none` instead: no connection sharing,
+  including any your ssh config sets up; keepalives still apply. The command
+  warns once per server on stderr, naming the path and the fix (an
+  `OATS_HOME_DIR` or `HOME` that is shorter or plain).
+- A master left stale by a network drop is replaced by ssh on the next call.
+- The version probe (`oats version --json`) is asked once per process per
+  server and target. `server add --replace` to another target forgets it.
+- When ssh fails under an attached viewer (a lost link, or one never made),
+  `session attach --server` exits 255 and says that, if the link was lost,
+  the instance keeps running on the server, with the command to reattach.
+  When ssh fails before the viewer opens (the version probe, or a name
+  resolved through the host's roster), it also exits 255, with `oats: ssh to
+  <host> failed: …` (`--json`: the `E_SSH` envelope). Every other refusal
+  (an incompatible host, an unknown or ambiguous name, bad arguments) exits 1,
+  and so does an ssh that cannot be run on this machine at all: no link can
+  come back.
+- Every routed command reports ssh's own failure as `E_SSH` (`ssh to <host>
+  failed: …`). When ssh never started on this machine, the `--json` envelope
+  says so with `error.details: {"sshStarted": false}`; without details, ssh
+  ran and the link failed
+  ([desktop-cli-api.md](desktop-cli-api.md#ssh-failures-e_ssh)).
+
 ## Run there
 
 ```bash
@@ -50,14 +96,18 @@ sent as text or on stdin, never as paths.
 |---|---|---|
 | `spawn` | registered workspace | the requested harness, backend and yolo option; `launch-config` for `--launch-config`; `schedule` for a wake schedule |
 | `status` | registered workspace | |
-| `retire` | saved route | `retire-home` to retire by exact home |
-| `session inspect`, `session attach` | saved route | `session` |
-| `session start`, `session restart` | saved route | `session-start`; `session-restart`; `launch-config` when `--launch-config`, `--harness` or `--yolo` is given |
-| `session upload` | saved route | `session-upload` |
+| `retire` | the instance's home | `retire-home` to retire by exact home |
+| `session inspect`, `session attach` | the instance's home | `session` |
+| `session start`, `session restart` | the instance's home | `session-start`; `session-restart`; `launch-config` when `--launch-config`, `--harness` or `--yolo` is given |
+| `session upload` | the instance's home | `session-upload` |
 | `okf harvest --instance <name>` | the saved home | `harvest` |
 | `schedule ...` | registered workspace | `schedule` |
-| `launch-config list\|set\|remove\|preview` | `--dir`, a saved route, or the registered workspace | `launch-config` |
-| `inspect`, `operation run` | `--dir`, a saved route, or the registered workspace | `operations` |
+| `launch-config list\|set\|remove\|preview` | `--dir`, the instance's home, or the registered workspace | `launch-config` |
+| `inspect`, `operation run` | `--dir`, the instance's home, or the registered workspace | `operations` |
+| `readiness` | the instance's home, `--dir`, or the registered workspace | `readiness` (`readinessApi: 2`) |
+| `instance events` | the instance's home | `instance-events-2` (`eventsApi: 2`) |
+| `instance git`, `instance diff` | the instance's home; the Git runs there | `instance-git` (`instanceGitApi: 1`) |
+| `instance stop --plan\|--apply`, `retire --plan`, `retire --plan-revision … --idempotency-key …` | the instance's home | `lifecycle-plans` (`lifecycleApi: 1`) |
 
 Before every routed command except `status`, the kernel reads the server's
 `oats version --json`. A remote OATS older than 0.22.1 is refused, and so is a
@@ -66,19 +116,36 @@ checked against the harness it would use (the flag, or the soul's default as
 the remote roster reports it). A host that advertises no harness list is
 assumed to run only pi and claude, on tmux, with no launch options.
 
-**Addressing an instance.** Instance commands take `--instance <name>` (spawned
-from this machine) or `--home </remote/home>`. The home is the identity; use it
-when two souls on the host own same-named instances. A name and a home that
-disagree are refused (`E_HOME_MISMATCH`).
-
-**`--dir` with `--server`.** For `inspect`, `operation` and `launch-config`,
-an explicit `--dir` names a directory on the server and travels as is. Every
-other routed command refuses `--dir`; its scope comes from the registration.
+**Addressing an instance.** Instance commands (`retire`, the `session`
+commands, `inspect`, `operation`, `launch-config`) reach any instance on the
+server, whoever spawned it, by `--home </remote/home>` or by name
+(`--instance <name>`, or the positional name of `retire`):
+
+- A name spawned from this machine resolves through its saved route.
+- Any other name resolves through the server's roster (one `status --json`
+  in the registered workspace) to its one home. A name that two homes carry
+  there is `E_AMBIGUOUS`, listing the homes (`error.details.candidates`);
+  pass `--home`. A name the roster does not list is `E_SNAPSHOT_UNKNOWN`.
+- A `--home` no saved route owns is sent through the registration's target;
+  the server's kernel decides whether it is an instance home and its refusal
+  is relayed as is.
+- The home is the identity; use it when two souls on the host own
+  same-named instances. A name and a home that disagree are refused
+  (`E_HOME_MISMATCH`).
+
+**`--dir` with `--server`.** For `inspect`, `operation`, `launch-config`,
+`readiness`, `instance`, and a `retire --plan` or guarded retire apply, an
+explicit `--dir` names a directory on the server and travels as is. Every
+other routed command refuses `--dir`; its scope comes from the
+registration.
 
 **Not routed.** `session input` runs on the execution host, where schedules
 and messaging capabilities call it. `session restart --stop-grace` is refused
 with `--server`; the remote default applies. `session attach --print` shows
-the ssh command without running it.
+the ssh command without running it. A server without the `session` commands
+(before 0.22.2) is refused with the tmux command to attach there directly,
+naming the session and window its roster records for the instance (else
+`pi-agents`, that kernel's default).
 
 ## The roster and harvest
 
@@ -91,8 +158,13 @@ The **roster** is what the Desktop shows: one group per server id and route
 target (host and workspace), with the registration (present or not), the
 probe result, the remote souls, the instances joined with saved routes
 (`savedRoute`, `running` or `null` when unknown, `retirePending`,
-`rollbackIncomplete`, `missingRemotely`), and `retireFailures` (deferred
-self-retirements that failed there). A removed or edited registration keeps
+`rollbackIncomplete`, `missingRemotely`, `addressable`), and `retireFailures`
+(deferred self-retirements that failed there). Each instance row also relays
+the host's own facts from its `status --json`: `identity`,
+`identityAddress`, `teams`, `startedAt`, `createdAt`, `model`,
+`runtimeState`, `parentInstance`, `siblingInstance`, `relation`,
+`relativeTo` and `spawnOrigin`. A fact the host does not supply is `null`
+(an older host, or a saved route the host no longer lists). A removed or edited registration keeps
 its group from the saved routes. State is pulled on every call within
 `--per-target` (default 20 s) of a total `--budget` (default 45 s); a group
 not reached is reported with `E_ROSTER_BUDGET`. `--server <id>` narrows it.
@@ -103,8 +175,8 @@ instance's saved home on the server and relays its envelope.
 ## What this machine keeps
 
 A **saved route** per remote instance, under `~/.oats/remote/<server>/`,
-written at spawn: the ssh host, workspace, oats path, optional Herdr path and
-PATH prefix, and the remote home. Retire, harvest and session commands use
+written at spawn: the ssh host, workspace, oats path and PATH prefix, and the
+remote home. Retire, harvest and session commands use
 the saved route, not the current registration, so editing or removing a
 registration never orphans a remote home. The route is removed when the
 remote kernel reports the home gone.
@@ -123,8 +195,5 @@ remote kernel reports the home gone.
 
 ## Limits
 
-- Lifecycle actions need a saved route from this machine. An instance the
-  remote reports but that was spawned elsewhere appears in the roster with
-  `savedRoute: false` and is read-only here.
 - No Git runs over SSH: repository operations always run on the server, by
   its kernel, in its deployment.

package/docs/souls-and-instances.md

@@ -85,8 +85,8 @@ launch: { harness: claude, model: claude-opus-5-5 }   # optional (0.30): what th
 
 Schema: [`soul.schema.json`](soul.schema.json). Which teams a soul joins is the
 deployment's choice (`oats-local.yaml`, [workspaces.md](workspaces.md#teams)),
-and the backend, yolo and launch configuration are spawn-time host choices
-(`--backend`, `--yolo`, `--launch-config`, or a launch configuration in
+and yolo and the launch configuration are spawn-time host choices
+(`--yolo`, `--launch-config`, or a launch configuration in
 `oats-local.yaml`), not soul identity. The harness and model are a soul's
 *preference* at most (`launch:`), which each machine overrides and spawn flags
 (`--harness`, `--model`) win over.

package/lib/attachments.mjs

@@ -147,7 +147,8 @@ export function uploadAttachment({ file, home, server, instance }, io = {}) {
     if (!home) throw err("E_BAD_ARGS", "session upload needs --home </absolute/instance> or --server <id> with --instance <name> or --home");
     return { ...receiveAttachment(home, name, bytes, { maxBytes }), name, home: realpathSync(home), source: abs };
   }
-  const route = resolveRoute(server, { instance, home }, "session upload");
+  io = { ...io, serverId: server };
+  const route = resolveRoute(server, { instance, home }, "session upload", io);
   const remote = checkRemote(route.target, io);
   // Both lists must carry the token; a probe without the arrays is an old kernel.
   const advertises = (list) => Array.isArray(list) && list.includes("session-upload");

package/lib/automations.mjs

@@ -34,6 +34,7 @@
 import { spawnSync } from "node:child_process";
 import { mkdirSync, readFileSync, renameSync, writeFileSync } from "node:fs";
 import { dirname, join } from "node:path";
+import { recordLocalInput } from "./local-inputs.mjs";
 import YAML from "yaml";
 import { parseConfigData } from "./config-data.mjs";
 
@@ -192,8 +193,11 @@ export function soulOriginOf(index, soul) {
 
 export const snapshotPath = (dep) => join(dep, ".agents", "automations", "snapshot.json");
 export function readSnapshot(dep) {
+  let text;
+  try { text = readFileSync(snapshotPath(dep), "utf8"); } catch { recordLocalInput(snapshotPath(dep), null); return null; }
+  recordLocalInput(snapshotPath(dep), text);
   try {
-    const doc = JSON.parse(readFileSync(snapshotPath(dep), "utf8"));
+    const doc = JSON.parse(text);
     return isObject(doc) && KIND_NAMES.every((k) => Array.isArray(doc[`${k}s`])) ? doc : null;
   } catch { return null; }
 }