@snappedly-tools/shipyard 0.2.0 → 0.3.1

package/README.md

@@ -23,7 +23,8 @@ branches, logs, sessions, and commits.
 
 ## Quick start
 
-You need Node.js, Git, Docker, and credentials for your chosen coding agent.
+You need Node.js 20.18.1 or newer, Git, Docker, and credentials for your chosen
+coding agent.
 Run these commands inside the Git repository the agent should change:
 
 ```sh
@@ -123,16 +124,18 @@ untracked or ignored files.
 the chosen agent. Keep `.shipyard/.env`, agent login files, logs, and recovery
 patches private.
 
-For Codex, choose either:
-
-- ChatGPT authentication: select `chatgpt` during init and complete the
-  browser login. The generated configuration mounts `~/.codex/auth.json`
-  read-only.
-- API authentication: select `api-key` and put `OPENAI_API_KEY` in
-  `.shipyard/.env`.
-
-For Claude Code, run `claude setup-token` and put the resulting value in the
-generated `CLAUDE_CODE_OAUTH_TOKEN` entry.
+Use a subscription first when the selected agent supports it. If subscription
+authentication does not work in your environment, use the API-key fallback:
+
+- Codex subscription authentication: run `codex login` on the host, then pass
+  `--codex-auth chatgpt` to `shipyard init`. The generated configuration mounts
+  `~/.codex/auth.json` read-only.
+- Codex API authentication: pass `--codex-auth api-key` and put
+  `OPENAI_API_KEY` in `.shipyard/.env`.
+- Claude Code subscription authentication: run `claude setup-token` on the
+  host and put the result in `CLAUDE_CODE_OAUTH_TOKEN` in `.shipyard/.env`.
+- Claude Code API authentication: uncomment `ANTHROPIC_API_KEY` in
+  `.shipyard/.env` and put your API key there.
 
 ## Generated files
 

package/dist/{SandboxProvider-KeFp_nju.d.ts → SandboxProvider-XJQqEdSf.d.ts}

@@ -16,6 +16,8 @@ interface InteractiveExecOptions {
     readonly stdout: NodeJS.WritableStream;
     readonly stderr: NodeJS.WritableStream;
     readonly cwd?: string;
+    /** Terminate the interactive process when the caller cancels the session. */
+    readonly signal?: AbortSignal;
 }
 /** Handle to a running bind-mount sandbox. */
 interface BindMountSandboxHandle {
@@ -48,6 +50,7 @@ interface BindMountSandboxHandle {
      * Optional — providers that support interactive sessions implement this.
      * The provider detects TTY mode from the streams (e.g. stdin.isTTY) and
      * allocates a pseudo-terminal accordingly.
+     * Implementations MUST terminate the underlying process when `signal` aborts.
      */
     interactiveExec?(args: string[], options: InteractiveExecOptions): Promise<{
         exitCode: number;
@@ -120,6 +123,7 @@ interface IsolatedSandboxHandle {
      * Optional — providers that support interactive sessions implement this.
      * The provider detects TTY mode from the streams (e.g. stdin.isTTY) and
      * allocates a pseudo-terminal accordingly.
+     * Implementations MUST terminate the underlying process when `signal` aborts.
      */
     interactiveExec?(args: string[], options: InteractiveExecOptions): Promise<{
         exitCode: number;