@osdlc/agent-seat 0.0.0-stage → 0.7.1

package/CHANGELOG.md

@@ -0,0 +1,133 @@
+# @osdlc/agent-seat
+
+## 0.7.1
+
+### Patch Changes
+
+- 29e2fb1: First public release. Opens an interactive coding-agent session (`claude`, `codex`, `cursor`, `pi`, `opencode`, `antigravity`) in the terminal app, multiplexer or editor a person already uses: the caller's own terminal, tmux, WezTerm, cmux, herdr, Orca, otty, VS Code or a JetBrains IDE. One host contract in optional parts (`session`, `terminal`, `send`, `find`, `focus`, `capture`, `close`, `openWorkspace`); `requirePart` returns the part or throws `HostPartMissing`. `hostRegistry({ runtimeDir })` builds every host, and hosts that keep state keep it under that directory. Every shell-out goes through an injected `@osdlc/command-seam` runner. The `vscode` and `jetbrains` hosts, their companion plumbing, the tmux attach helpers and `hostCanWait` are experimental. Compared with the unpublished 0.7.0, the tmux session name, the otty title tag and the session-pane file name now end in a hash of the session id, and WezTerm keeps one `spawned/<paneId>.json` per pane instead of `panes.json`; a session opened by an earlier build is not found by `send`, `find` or `close`. The versions before 0.7.1 were never published; the history in this file rebuilds them from the git history.
+
+## History before the first public release
+
+These versions were never published. They are rebuilt from the git history.
+
+### [0.7.0] - 2026-10-22 (unpublished)
+
+#### Added
+
+- The `openWorkspace` part, `OpenWorkspaceQuery`, `OpenedWorkspace` and `ensureWorkspace`;
+  `JetbrainsSettings`.
+
+#### Changed
+
+- Breaking: the JetBrains host requires companion plugin protocol 2 and skips older plugins.
+
+### [0.6.5] - 2026-10-19 (unpublished)
+
+#### Fixed
+
+- `harnessAvailable` finds the harness binary with the same PATH lookup on every platform.
+
+### [0.6.4] - 2026-10-18 (unpublished)
+
+#### Added
+
+- `SessionRequest.wait`, `WaitRequest`, `WAIT_TIMEOUT_EXIT` and `hostCanWait`: tmux can hold a
+  launch until the session exits.
+
+### [0.6.3] - 2026-10-16 (unpublished)
+
+#### Added
+
+- `FindQuery.harness`: Orca delivers to the one terminal running that harness.
+
+### [0.6.2] - 2026-10-11 (unpublished)
+
+#### Added
+
+- The `close` part; `SendRequest` and `FindQuery` take `sessionId`, and hosts bind a pane to the
+  session id it was opened for.
+
+### [0.6.1] - 2026-10-11 (unpublished)
+
+#### Added
+
+- `SessionRequest.wrap`: run the harness under a wrapper command.
+
+### [0.6.0] - 2026-10-11 (unpublished)
+
+#### Changed
+
+- Breaking: `harnessArgv(harness, binary, prompt, ...)` and `harnessAvailable(harness, binary)`
+  take the binary; `SessionRequest.binary` is required; `Harness` is any tool id, validated by
+  `HarnessSchema`. Model, effort and launch-mode fields on `SessionRequest`.
+
+### [0.5.0] - 2026-10-11 (unpublished)
+
+#### Added
+
+- Hosts `herdr`, `otty`, `wezterm`, `vscode` and `jetbrains`; the `capture` part;
+  `supportsPlatform`; Claude hook settings (`claudeHookSettings`, `CLAUDE_HOOK_EVENTS`).
+
+#### Changed
+
+- Breaking: `Host.platforms` is required; `SendReceipt.deliveryKnown` is now `ack`, with
+  `uncertain`.
+
+### [0.4.1] - 2026-10-10 (unpublished)
+
+#### Fixed
+
+- Hosts read command results through the command seam's helpers; no behaviour change.
+
+### [0.4.0] - 2026-10-07 (unpublished)
+
+#### Changed
+
+- Breaking: the `session` part returns `harnessSessionId` instead of `hostSessionId`.
+
+### [0.3.4] - 2026-10-06 (unpublished)
+
+#### Added
+
+- Claude session flags: `ClaudeSessionFlagsSchema`, `claudeSessionArgv`, `claudeResumeArgv`, and
+  plugins and a system prompt on `SessionRequest`. An `env` entry can unset a variable.
+
+### [0.3.3] - 2026-10-06 (unpublished)
+
+#### Added
+
+- The `focus` part, `SessionRequest.env`, `withEnv` and `insideTmux`. Orca sends by terminal
+  handle.
+
+### [0.3.2] - 2026-09-28 (unpublished)
+
+#### Added
+
+- `makeTerminalHost`, taking a streaming runner.
+
+### [0.3.1] - 2026-09-28 (unpublished)
+
+#### Added
+
+- `walkRolloutFiles`.
+
+### [0.3.0] - 2026-09-28 (unpublished)
+
+#### Changed
+
+- Breaking: `SessionRequest.engine` is `harness`, and hosts are wrappers that run any harness; the
+  per-harness host names are gone. The tmux host, the `pi` harness, the `send` and `find` parts,
+  and `HostRegistry`, `SendReceipt` and `FoundSession`.
+
+### [0.2.0] - 2026-09-27 (unpublished)
+
+#### Changed
+
+- Breaking: the `session` part returns `{ exitCode, hostSessionId }`; `HostNameSchema`.
+
+### [0.1.0] - 2026-09-10 (unpublished)
+
+#### Added
+
+- The host contract (`Host`, `HostParts`, `requirePart`, `HostPartMissing`, `HOST_NAMES`,
+  `onPath`) with the `terminal`, `orca` and `cmux` hosts.

package/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+Thanks for your interest in this package.
+
+## Issues
+
+Report bugs and ask for features in the issue tracker of the repository that
+hosts this package. For a bug, include the package version, your runtime and
+its version, your operating system, the host and harness, and the call and
+inputs that misbehave. Report security problems privately. See
+[SECURITY.md](./SECURITY.md).
+
+## Pull requests
+
+Open pull requests against the repository that hosts this package. They are
+reviewed and merged there.
+
+## Running the tests
+
+The tests run under [Vitest](https://vitest.dev) on Node. The package lives in the pnpm workspace of
+[osdlc/osdlc](https://github.com/osdlc/osdlc). Build it and the libraries it
+depends on first, then run the checks from the package directory:
+
+```sh
+pnpm --filter @osdlc/agent-seat... build
+pnpm test
+pnpm run typecheck
+pnpm run lint
+pnpm run format:check
+pnpm run smoke
+```
+
+The tests need no terminal app: every host is driven through a fake command
+runner. `tests/tmux-live.test.ts` also runs against a real tmux server when
+`tmux` is installed, and is skipped otherwise.
+
+## Code style
+
+- TypeScript and ES modules, compiled to `dist/` by `tsc -p tsconfig.build.json`.
+- A change users can see comes with a changeset (`pnpm changeset` at the
+  repository root).
+- Prettier formats the code and oxlint checks it.
+- Every subprocess goes through an injected `CommandRunner`.
+- Add a test for each behaviour change or bug fix.

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 sksizer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sksizer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,182 @@
-# Temporary Holding Version
+# @osdlc/agent-seat
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Open an interactive coding-agent session where a person already works.
+
+A tool that starts coding agents for a person (a task runner, a review bot,
+an orchestrator) has to put each session somewhere the person can see and
+answer it: a new terminal tab, a tmux session, a WezTerm pane, a VS Code
+terminal. Each of those places has its own CLI or protocol, its own way to
+name a pane, and its own failure modes. This package gives them one contract.
+
+- A **host** is one place a session can open. Nine are built in: `terminal`,
+  `tmux`, `wezterm`, `cmux`, `herdr`, `orca`, `otty`, `vscode` and `jetbrains`.
+- A **harness** is the agent CLI that runs in it: `claude`, `codex`, `cursor`,
+  `pi` and `opencode` have an interactive launch.
+- The two are independent. Every host runs any harness, so where a session
+  opens and which agent runs in it are separate choices.
+
+A host fulfils the contract in parts: open a session, run a command, send text
+into an open session, find, focus, capture its screen, close it, open a
+workspace. A host offers only the parts its app supports. A caller asks for the
+part it needs with `requirePart` and gets a `HostPartMissing` error naming the
+host and the part when it is missing, never a silent fallback to another host.
+
+**Not for:** headless agent runs whose output a program reads (`claude -p`,
+`codex exec`); use [`@osdlc/agent-call`](https://www.npmjs.com/package/@osdlc/agent-call)
+for those. Not for embedding a terminal in your own UI either: a host drives
+an app the person already has.
+
+## Install
+
+```sh
+npm install @osdlc/agent-seat
+```
+
+ESM only, with type declarations. Node.js 22.22.2 or later on the 22 line, 24.15.0 or
+later on the 24 line, or 26 and later.
+
+## Quick start
+
+```ts
+import { hostRegistry, requirePart } from '@osdlc/agent-seat'
+
+// Hosts that remember panes keep their files under <runtimeDir>/hosts/<name>.
+const hosts = hostRegistry({ runtimeDir: '/tmp/my-tool/run' })
+
+const tmux = hosts.tmux
+if (tmux.available()) {
+  const open = requirePart(tmux, 'session')
+  const { exitCode } = open({
+    cwd: process.cwd(),
+    harness: 'claude',
+    binary: 'claude',
+    prompt: 'Summarise the open TODOs in this repository.',
+    title: 'todo review',
+    sessionId: 'todo-review', // your id; later calls reach this pane by it
+  })
+}
+```
+
+Later, type into the same session and read it back:
+
+```ts
+const query = { cwd: process.cwd(), sessionId: 'todo-review' }
+
+const receipt = requirePart(tmux, 'send')({ ...query, text: 'Also check FIXME comments.' })
+// { accepted: true, ack: false }: typed and submitted; tmux cannot confirm the agent read it
+
+const screen = requirePart(tmux, 'capture')(query) // what the pane shows now
+```
+
+`examples/readme.test.ts` and `examples/guide.test.ts` run these examples
+against a recording command runner.
+
+## Guide
+
+- [Getting started](./docs/guide/getting-started.md): hosts, harnesses and parts;
+  opening a session; choosing a host.
+- [Working with open sessions](./docs/guide/sessions.md): send, find, focus,
+  capture and close, and what a send receipt means.
+- [Hosts](./docs/guide/hosts.md): what each host needs and how it behaves.
+- [Testing](./docs/guide/testing.md): fake command runners and fake hosts.
+
+Why the package has the shape it has, and the research on each host app, are in
+[docs/planning/](./docs/planning/README.md).
+
+## Hosts
+
+| Host | Platforms | Needs | Parts beyond `session` and `terminal` |
+|---|---|---|---|
+| `terminal` | all | nothing; runs in the caller's own terminal and blocks until the session exits | none |
+| `tmux` | macOS, Linux | `tmux` on `PATH` | send, find, focus, capture, close; can wait for the session to exit |
+| `wezterm` | all | `wezterm` on `PATH` and a running WezTerm | send, find, focus, capture, close |
+| `cmux` | macOS | the cmux app and its CLI | send, find, focus, capture, close |
+| `herdr` | macOS, Linux | `herdr` on `PATH` | send, find, focus, capture, close |
+| `orca` | macOS | the Orca app (its bundled CLI is found) | send, find, focus, close |
+| `otty` | macOS | the otty app and its CLI | send, find, focus, capture, close |
+| `vscode` | all | a VS Code, Cursor or Windsurf window with the `sdlc-host` extension | send, find, focus, close |
+| `jetbrains` | macOS | a JetBrains IDE with the companion plugin, and `curl` | send, find, focus, open workspace |
+
+`host.platforms` and `supportsPlatform(host)` say where a host runs;
+`available()` says whether it can open a session right now.
+
+The `vscode` and `jetbrains` hosts talk to a companion extension or plugin
+over a local socket or loopback HTTP. The companions are not published yet, so
+outside the project that builds them these two hosts report themselves
+unavailable.
+
+## Sessions, panes and state
+
+A launch can carry a session id (`SessionRequest.sessionId`). A host binds
+the pane it opens to that id, so a later `send`, `find`, `focus`, `capture` or
+`close` reaches that pane even when another session shares the working
+directory. Hosts that cannot name a pane by itself remember the binding in a
+file under `<runtimeDir>/hosts/<name>/sessions/`; the VS Code and JetBrains
+companions register their windows under `<runtimeDir>/hosts/<name>/`. Pass the
+same `runtimeDir` to every process that should see the same sessions.
+
+Each stateful host factory (`makeOrcaHost`, `makeHerdrHost`, `makeWeztermHost`,
+`makeVscodeHost`, `makeJetbrainsHost`) takes `runtimeDir`, or `registryDir`
+for the host's own directory.
+
+## Harnesses
+
+`harnessArgv(harness, binary, prompt, claudeFlags?, choice?)` builds the argv
+for an interactive launch: the bare CLI with the first message, plus the model
+and effort flags of a resolved `choice`. `harnessAvailable(harness, binary)` asks
+whether `binary` is on PATH. `claudeSessionArgv` and `claudeHookSettings` build
+the Claude Code flags a session can carry (plugins, a system prompt, hook
+settings). `findCodexSessionId` finds the id of a codex session from its
+rollout file.
+
+## Compared with other tools
+
+| Tool | Difference |
+|---|---|
+| [`@osdlc/agent-call`](https://www.npmjs.com/package/@osdlc/agent-call) | Runs an agent headless and returns its output to your program. This package opens a session a person sees and can answer. |
+| `pi-terminal-mux` | One API over terminal multiplexers (tmux, zellij, WezTerm, herdr, cmux, otty, Orca). No caller's own terminal, no editors, no find, focus or open-workspace, and no notion of which agent runs where. |
+| tmux wrappers (`node-tmux`, `libtmux`) | One multiplexer only. |
+| Agent managers (claude-squad, ccmanager, uzi) | Applications with their own UI, mostly tmux-only, not libraries. |
+| `node-pty` | Embeds a terminal in your own process. This package drives an app the person already has open. |
+
+## Shell-outs
+
+Every host runs its app's CLI through an injectable
+[`@osdlc/command-seam`](https://www.npmjs.com/package/@osdlc/command-seam)
+`CommandRunner` (the `runner` option), never through a shell string, so a test
+can replace the app with a recording fake.
+
+## API
+
+The package entry exports the host contract (`Host`, `HostParts`,
+`requirePart`, `HostPartMissing`, `supportsPlatform`, `HOST_NAMES`), one
+factory per host, `hostRegistry`, the harness argv builders and
+`ensureWorkspace`. Each export carries TSDoc; the [guide](#guide) shows them in
+use.
+
+## Stability
+
+The package is at 0.x: a minor release may change any item. The items below are
+experimental as well: they may change or go away in any release, and their TSDoc
+says why.
+
+- Hosts that need a companion that is not published yet: `makeVscodeHost`,
+  `makeJetbrainsHost`, `JetbrainsSettings`, `JETBRAINS_PROTOCOL`,
+  `liveWindows`, `subprocessTransport`, `VscodeWindow`, `VscodeReply`,
+  `VscodeTransport`.
+- tmux attach helpers, to be replaced by an `attach` part: `tmuxSessionName`,
+  `tmuxIdSessionName`, `tmuxAttachArgv`, `tmuxSwitchClientArgv`, `insideTmux`.
+- `hostCanWait`, to become a declaration on the host.
+
+## Known limits
+
+- Windows: not yet run on Windows. Env overrides (`withEnv`) and hosts that hand
+  a terminal one command line go through Windows PowerShell 5.1, which passes
+  an argument containing `"` to the program without escaping it and drops an
+  empty argument; `powershell -Command` also reports the program's exit code
+  only as 0 or 1.
+
+## Licence
+
+`MIT OR Apache-2.0`, at your option. See [LICENSE-MIT](./LICENSE-MIT) and
+[LICENSE-APACHE](./LICENSE-APACHE).

package/SECURITY.md

@@ -0,0 +1,41 @@
+# Security policy
+
+## Reporting a vulnerability
+
+Please report vulnerabilities privately. Do not open a public issue.
+
+Use GitHub private vulnerability reporting on the repository that hosts this
+package: open its Security tab and choose "Report a vulnerability".
+
+Include the version, a short description, and steps to reproduce. A minimal
+code sample helps.
+
+## Supported versions
+
+Only the latest release gets security fixes. While the version is 0.x, that
+is the latest minor release. Upgrade to it.
+
+## What this package runs
+
+- Each host runs its app's CLI (`tmux`, `wezterm`, `cmux`, `herdr`, `orca`,
+  `otty`, `curl`) as an argument vector through the command runner it is
+  given. No shell parses the arguments, except where a host must hand one
+  command line to a terminal app; that line is quoted for the target shell
+  (POSIX `sh`, or PowerShell on Windows).
+- The text a caller sends into a session (`send`) is typed into that session as
+  is. The agent there reads it as a person's input.
+- The `vscode` and `jetbrains` hosts read registry files under the caller's
+  `runtimeDir` and talk to the window or IDE named there, on a local socket or
+  on `127.0.0.1`, with the per-window token from that file. They send that
+  window each session's command line (environment values included) and the
+  text sent into it. `runtimeDir` must be private to the user (mode `0700`).
+  On POSIX a registry directory or file that another user owns, or that its
+  group or others can write, is ignored; the JetBrains host names it among the
+  IDEs it skipped. Windows has no such check.
+- Pane bindings are written under `<runtimeDir>/hosts/<name>/sessions/`.
+
+## What to expect
+
+This is a small project. We aim to reply within a week. We will tell you
+whether we accept the report and keep you updated until a fix is released.
+We will credit you in the release notes if you want that.