Files
PaperClipAI/packages/adapter-utils
Devin FoleyandPaperclip 29c3d15507 feat(adapter-utils): report SSH/remote-managed sync + git import/export progress
Threads the PAPA-827 onProgress sink through the SSH transport so workspace
upload, restore/sync-back, and git-history import/export emit throttled byte
progress lines in the same log stream.

- syncDirectoryToSsh: byte-counting Transform spliced between tar.stdout and
  ssh.stdin; estimates the total by walking localDir (honoring exclude/
  followSymlinks) and clamps reported percent <= 99% until the pipe closes,
  then emits the terminal 100%.
- syncDirectoryFromSsh: counter on ssh.stdout; best-effort remote `du -sk`
  probe for an estimate, else MB-received mode, with a terminal completion line.
- importGitWorkspaceToSsh: exact percentage from the known bundle size via
  streamLocalFileToSsh ("Importing git history").
- exportGitWorkspaceFromSsh: bytes-received MB mode via streamSshToLocalFile
  ("Exporting git history").
- prepare/restoreWorkspaceForSshExecution and prepareRemoteManagedRuntime
  forward onProgress (workspace + per-asset labels) and the restoreWorkspace
  closure threads it through.
- ssh-fixture tests cover upload clamp/terminal, restore terminal line, and
  exact git-import percentage.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-06-19 11:45:22 -07:00
..
2026-03-12 13:09:22 -05:00

@paperclipai/adapter-utils

Shared utilities for Paperclip adapters: process spawning, environment injection, sandbox/SSH transport, workspace sync, and the round-trip helpers that move code between the local execution-workspace cwd and wherever the agent actually runs.

For the adapter-author guide see docs/adapters/creating-an-adapter.md and the in-repo notes at packages/adapters/AUTHORING.md.

No-remote-git contract

The local execution-workspace cwd is the only persistence boundary across runs. No adapter may depend on a git remote for cross-run state.

Adapters that run the agent on a different host should use the SSH round-trip helpers in src/ssh.ts:

  • prepareWorkspaceForSshExecution({ spec, localDir, remoteDir }) — bundles the local cwd (tracked files, dirty edits, untracked additions, and the git history needed to reconstruct it) to remoteDir before the run starts. Runs with no git remote configured.
  • restoreWorkspaceFromSshExecution({ spec, localDir, remoteDir, ... }) — syncs the remote cwd back into localDir after the run, including any new commits the agent created. Also runs with no git remote configured.

prepareRemoteManagedRuntime in src/remote-managed-runtime.ts wraps both calls for adapters that want a per-run remote workspace and an automatic restoreWorkspace() finally hook.

The invariant is pinned by the no-remote-git contract case in src/ssh-fixture.test.ts, which asserts that a remote-only commit propagates to the local worktree through the prepare → restore round-trip with no git remote configured at any point. Do not regress that test.