@snappedly-tools/shipyard 0.8.0 → 0.9.1-staging.36234719249

package/README.md

@@ -39,9 +39,10 @@ npm install --save-dev @snappedly-tools/shipyard
 npx shipyard init
 ```
 
-During `shipyard init`, choose your agent, **Docker**, the template you want, and install the optional
-[repository runner](docs/content/docs/repository-runner.mdx). Follow
-the authentication prompts.
+During `shipyard init`, choose your agent and template, then follow the
+authentication prompts. GitHub Issues is the built-in tracker. Init builds the
+Docker image and automatically installs the
+[repository runner](docs/content/docs/repository-runner.mdx).
 
 On a local Mac, the repository runner automatically wakes Shipyard when you label an issue.
 It runs as long as its terminal stays open.
@@ -52,25 +53,31 @@ branch options.
 Fill in any credentials required in `.shipyard/.env`.
 `GH_TOKEN` in `.shipyard/.env` to a GH token with Contents, Issues, and Pull
 Requests read/write access and Metadata read access.
+
 Set `SHIPYARD_ROUTINE_MODEL` and `SHIPYARD_STRONG_MODEL` in `.shipyard/.env`
-for the roles your template uses. `simple-loop` uses routine for triage and
+for the roles your template uses.
+
+`simple-loop` uses routine for triage and
 implementation. `sequential-reviewer` also uses strong for issue reviews.
 Parallel planner templates use routine for ticket work and strong for planning,
 conflict resolution, and integration. The review-enabled planner also uses
 strong for ticket and final specification reviews. See
 [agent setup](docs/content/docs/agents.mdx).
 
-Commit the setup and prompt so the sandbox can read them. Make sure the Git ignore file keeps
-`.shipyard/.env` out of the commit.
+```sh
+npx shipyard runner start
+```
+
+To start Shipyard for a single run without the active runner, use:
 
 ```sh
 npx shipyard run
 ```
 
-Or for the automated runner:
+To remove Shipyard from the repository:
 
 ```sh
-npx shipyard runner start
+npx shipyard uninstall
 ```
 
 ## Turn GitHub issues into pull requests
@@ -79,8 +86,8 @@ Then:
 
 1. Write an issue with a clear goal and add the `shipyard` and
    `ready-for-agent` labels.
-2. Make sure the runner is running, or start `npx shipyard run`. Shipyard checks the issue, implements it in Docker,
-   reviews the work, and opens a pull request.
+2. Run Shipyard to check for the issue, implement it in Docker,
+   review the work, and open a pull request.
 3. Inspect the pull request and merge it when you are happy with the result.
 
 ## Choose a workflow
@@ -92,10 +99,13 @@ Then:
 | `parallel-planner`             | Plans and works on independent issues in parallel. |
 | `parallel-planner-with-review` | Adds review to the parallel workflow.              |
 
-Shipyard also exports TypeScript APIs for custom workflows. Configure prompts,
-branches, limits, and hooks in the generated `.shipyard/main.ts` or
-`.shipyard/main.mts`. See [configuration](docs/content/docs/configuration.mdx)
-and [agent setup](docs/content/docs/agents.mdx).
+The package root exports the core run, interactive, and sandbox APIs. Import
+hosted workflow coordination and GitHub integration APIs from
+`@snappedly-tools/shipyard/workflow` and
+`@snappedly-tools/shipyard/integrations/github`. Configure prompts, branches,
+limits, and hooks in the generated `.shipyard/main.ts` or `.shipyard/main.mts`.
+See [configuration](docs/content/docs/configuration.mdx) and
+[agent setup](docs/content/docs/agents.mdx).
 
 ## Safety and license
 

package/dist/MountConfig-K5ILnfht.d.ts

@@ -0,0 +1,26 @@
+/**
+ * User-facing mount configuration for Docker.
+ *
+ * Each entry describes a host directory to mount into the sandbox container.
+ */
+/** A single bind-mount descriptor for the Docker provider. */
+interface MountConfig {
+    /**
+     * Path on the host. Supports:
+     * - Absolute paths (`/data/cache`)
+     * - Tilde-expanded paths (`~/data` → `<home>/data`)
+     * - Relative paths (`data` or `./data`) — resolved from `process.cwd()`
+     */
+    readonly hostPath: string;
+    /**
+     * Path inside the sandbox container. Supports:
+     * - Absolute paths (`/mnt/data`)
+     * - Tilde-expanded paths (`~/.npm` → `/home/agent/.npm`) — expanded using the provider's sandbox home directory
+     * - Relative paths (`data` or `./data`) — resolved from the worktree directory (`/home/agent/workspace`)
+     */
+    readonly sandboxPath: string;
+    /** Mount as read-only. Defaults to `false`. */
+    readonly readonly?: boolean;
+}
+
+export type { MountConfig as M };

package/dist/{MountConfig-BHnKnA4h.d.ts → SandboxProvider-oUAwYlWm.d.ts}

@@ -117,29 +117,4 @@ type BranchStrategy = MergeToHeadBranchStrategy | NamedBranchStrategy;
 /** Construct the isolated provider contract used by Docker. */
 declare const createIsolatedSandboxProvider: (config: IsolatedSandboxProviderConfig) => IsolatedSandboxProvider;
 
-/**
- * User-facing mount configuration for Docker.
- *
- * Each entry describes a host directory to mount into the sandbox container.
- */
-/** A single bind-mount descriptor for the Docker provider. */
-interface MountConfig {
-    /**
-     * Path on the host. Supports:
-     * - Absolute paths (`/data/cache`)
-     * - Tilde-expanded paths (`~/data` → `<home>/data`)
-     * - Relative paths (`data` or `./data`) — resolved from `process.cwd()`
-     */
-    readonly hostPath: string;
-    /**
-     * Path inside the sandbox container. Supports:
-     * - Absolute paths (`/mnt/data`)
-     * - Tilde-expanded paths (`~/.npm` → `/home/agent/.npm`) — expanded using the provider's sandbox home directory
-     * - Relative paths (`data` or `./data`) — resolved from the worktree directory (`/home/agent/workspace`)
-     */
-    readonly sandboxPath: string;
-    /** Mount as read-only. Defaults to `false`. */
-    readonly readonly?: boolean;
-}
-
-export { type BranchStrategy as B, type ExecResult as E, type IsolatedSandboxProvider as I, type MountConfig as M, type NamedBranchStrategy as N, type SessionTransferHandle as S, type SandboxProvider as a, type MergeToHeadBranchStrategy as b, type InteractiveExecOptions as c, type IsolatedCreateOptions as d, type IsolatedSandboxHandle as e, type IsolatedSandboxProviderConfig as f, createIsolatedSandboxProvider as g };
+export { type BranchStrategy as B, type ExecResult as E, type IsolatedSandboxProvider as I, type MergeToHeadBranchStrategy as M, type NamedBranchStrategy as N, type SandboxProvider as S, type InteractiveExecOptions as a, type IsolatedCreateOptions as b, type IsolatedSandboxHandle as c, type IsolatedSandboxProviderConfig as d, createIsolatedSandboxProvider as e, type SessionTransferHandle as f };

package/dist/{chunk-L6PX5QTU.js → chunk-57EEKW3R.js}

@@ -31,12 +31,21 @@ var SilentDisplay = {
     ),
     progress: (title, effect) => Effect.gen(function* () {
       const updates = [];
-      const result = yield* effect((update) => updates.push(update));
+      const report = Object.assign(
+        (update) => {
+          updates.push(update);
+        },
+        { pause: () => {
+        }, resume: () => {
+        } }
+      );
+      const exit = yield* Effect.exit(effect(report));
       yield* Ref.update(ref, (entries) => [
         ...entries,
         { _tag: "progress", title, updates: [...updates] }
       ]);
-      return result;
+      if (Exit.isFailure(exit)) return yield* Effect.failCause(exit.cause);
+      return exit.value;
     }),
     summary: (title, rows) => Ref.update(ref, (entries) => [
       ...entries,
@@ -140,7 +149,15 @@ var FileDisplay = {
           yield* appendToLog(`${title}...`);
           const start = Date.now();
           const updates = [];
-          const result = yield* effect((update) => updates.push(update));
+          const report = Object.assign(
+            (update) => {
+              updates.push(update);
+            },
+            { pause: () => {
+            }, resume: () => {
+            } }
+          );
+          const result = yield* effect(report);
           for (const update of updates) {
             yield* appendToLog(
               `  ${update.message} (${update.current}/${update.total})`
@@ -211,25 +228,39 @@ var ClackDisplay = {
     ),
     progress: (title, effect) => Effect.acquireUseRelease(
       Effect.sync(() => {
-        const progress2 = clack.progress({ max: 100 });
+        const progress2 = clack.progress({ max: 100, withGuide: false });
         let percent = 0;
+        let currentMessage = title;
+        let paused = false;
         progress2.start(title);
-        const report = (update) => {
+        const report = ((update) => {
           const total = Math.max(1, update.total);
           const current = Math.min(total, Math.max(0, update.current));
           const nextPercent = Math.round(current / total * 100);
           const message = `${update.message} (${current}/${total})`;
+          currentMessage = message;
           if (nextPercent > percent) {
             progress2.advance(nextPercent - percent, message);
           } else {
             progress2.message(message);
           }
           percent = nextPercent;
+        });
+        report.pause = () => {
+          if (paused) return;
+          progress2.clear();
+          paused = true;
+        };
+        report.resume = () => {
+          if (!paused) return;
+          progress2.start(currentMessage);
+          paused = false;
         };
         return { progress: progress2, report };
       }),
       ({ report }) => effect(report),
-      ({ progress: progress2 }, exit) => Effect.sync(() => {
+      ({ progress: progress2, report }, exit) => Effect.sync(() => {
+        report.resume();
         if (exit._tag === "Success") {
           progress2.stop(`${title} complete`);
         } else {
@@ -1053,22 +1084,21 @@ var formatCommandBlock = (commands) => {
   }
   return commands.map((cmd, i) => i < commands.length - 1 ? `  ${cmd} && \\` : `  ${cmd}`).join("\n");
 };
-
-// src/syncOut.ts
 var execHostGit2 = (args, cwd) => Effect.tryPromise({
   try: () => execHostGit(args, cwd),
-  catch: (e) => new SyncError({
+  catch: (error) => new SyncError({
     message: `Host command failed: git ${args.join(" ")}
-${e instanceof Error ? e.message : String(e)}`
+${error instanceof Error ? error.message : String(error)}`
   })
 });
-var execOk = (handle, command, options) => Effect.tryPromise({
+var execSandbox = (handle, command, options) => Effect.tryPromise({
   try: () => handle.exec(command, options),
-  catch: (e) => new SyncError({
+  catch: (error) => new SyncError({
     message: `Sandbox exec failed: ${command}
-${e instanceof Error ? e.message : String(e)}`
+${error instanceof Error ? error.message : String(error)}`
   })
-}).pipe(
+});
+var execOk = (handle, command, options) => execSandbox(handle, command, options).pipe(
   Effect.flatMap(
     (result) => result.exitCode !== 0 ? Effect.fail(
       new SyncError({
@@ -1078,13 +1108,8 @@ ${result.stderr}`
     ) : Effect.succeed(result)
   )
 );
-var execSandbox = (handle, command, options) => Effect.tryPromise({
-  try: () => handle.exec(command, options),
-  catch: (e) => new SyncError({
-    message: `Sandbox exec failed: ${command}
-${e instanceof Error ? e.message : String(e)}`
-  })
-});
+
+// src/syncOut.ts
 var isEmptyPatch = (patchPath) => Effect.tryPromise({
   try: async () => {
     const info = await stat(patchPath);
@@ -1977,32 +2002,9 @@ var WorktreeDockerSandboxFactory = {
     })
   )
 };
-var execHostGit3 = (args, cwd) => Effect.tryPromise({
-  try: () => execHostGit(args, cwd),
-  catch: (e) => new SyncError({
-    message: `Host command failed: git ${args.join(" ")}
-${e instanceof Error ? e.message : String(e)}`
-  })
-});
-var execOk3 = (handle, command, options) => Effect.tryPromise({
-  try: () => handle.exec(command, options),
-  catch: (e) => new SyncError({
-    message: `Sandbox exec failed: ${command}
-${e instanceof Error ? e.message : String(e)}`
-  })
-}).pipe(
-  Effect.flatMap(
-    (result) => result.exitCode !== 0 ? Effect.fail(
-      new SyncError({
-        message: `Sandbox command failed (exit ${result.exitCode}): ${command}
-${result.stderr}`
-      })
-    ) : Effect.succeed(result)
-  )
-);
 var syncIn = (hostRepoDir, handle) => Effect.gen(function* () {
   const protectedRunnerPath = `${CONFIG_DIR}/${RUNNER_DIR}`;
-  const runnerObjects = yield* execHostGit3(
+  const runnerObjects = yield* execHostGit2(
     ["rev-list", "--objects", "--all", "--", protectedRunnerPath],
     hostRepoDir
   );
@@ -2013,7 +2015,7 @@ var syncIn = (hostRepoDir, handle) => Effect.gen(function* () {
       })
     );
   }
-  const branch = (yield* execHostGit3(
+  const branch = (yield* execHostGit2(
     ["rev-parse", "--abbrev-ref", "HEAD"],
     hostRepoDir
   )).trim();
@@ -2026,11 +2028,11 @@ var syncIn = (hostRepoDir, handle) => Effect.gen(function* () {
   const bundleHostPath = join(bundleDir, "repo.bundle");
   yield* Effect.ensuring(
     Effect.gen(function* () {
-      yield* execHostGit3(
+      yield* execHostGit2(
         ["bundle", "create", bundleHostPath, "--all"],
         hostRepoDir
       );
-      const mkTempResult = yield* execOk3(
+      const mkTempResult = yield* execOk(
         handle,
         `mktemp -d -t ${RUNTIME_NAMESPACE}-XXXXXX`
       );
@@ -2043,26 +2045,26 @@ var syncIn = (hostRepoDir, handle) => Effect.gen(function* () {
         })
       });
       const worktreePath = handle.worktreePath;
-      yield* execOk3(
+      yield* execOk(
         handle,
         `git clone ${shellQuote(bundleSandboxPath)} ${shellQuote(`${worktreePath}_clone`)}`
       );
-      yield* execOk3(
+      yield* execOk(
         handle,
         `rm -rf ${shellQuote(worktreePath)} && mv ${shellQuote(`${worktreePath}_clone`)} ${shellQuote(worktreePath)}`
       );
-      yield* execOk3(handle, `git checkout ${shellQuote(branch)}`, {
+      yield* execOk(handle, `git checkout ${shellQuote(branch)}`, {
         cwd: worktreePath
       });
       yield* Effect.tryPromise({
         try: () => handle.exec(`rm -rf ${shellQuote(sandboxTmpDir)}`),
         catch: () => new SyncError({ message: "Failed to clean up sandbox temp dir" })
       });
-      const hostHead = (yield* execHostGit3(
+      const hostHead = (yield* execHostGit2(
         ["rev-parse", "HEAD"],
         hostRepoDir
       )).trim();
-      const sandboxHead = (yield* execOk3(handle, "git rev-parse HEAD", {
+      const sandboxHead = (yield* execOk(handle, "git rev-parse HEAD", {
         cwd: worktreePath
       })).stdout.trim();
       if (hostHead !== sandboxHead) {
@@ -2181,5 +2183,5 @@ var startSandbox = (options) => Effect.gen(function* () {
 });
 
 export { ACTIVATION_LABEL, AgentError, AgentIdleTimeoutError, CLI_NAME, CONFIG_DIR, ClackDisplay, ConfigDirError, CopyToWorktreeError, CopyToWorktreeTimeoutError, CwdError, Display, DockerError, ExecHostError, FileDisplay, InitError, LOCKS_DIR, LOGS_DIR, PRODUCT_NAME, PromptError, PromptExpansionTimeoutError, RUNNER_DIR, RUNTIME_NAMESPACE, SANDBOX_REPO_DIR, SandboxConfig, SandboxFactory, SessionCaptureError, SilentDisplay, WorktreeDockerSandboxFactory, assertExcludesRepositoryRunner, assertNoSymlinkComponents, assertProtectedDirectoryIdentities, create, createIsolatedSandboxProvider, generateTempBranchName, getCurrentBranch, hasUncommittedChanges, makeSandboxFromHandle, pruneStale, registerShutdown, remove, repositoryRunnerEnvironment, resolveCwd, resolveSafeRelativePath, runHostHooks, shellQuote, startSandbox, syncOut, toSessionTransferHandle, withSandboxLifecycle, withTimeout };
-//# sourceMappingURL=chunk-L6PX5QTU.js.map
-//# sourceMappingURL=chunk-L6PX5QTU.js.map
+//# sourceMappingURL=chunk-57EEKW3R.js.map
+//# sourceMappingURL=chunk-57EEKW3R.js.map