Files
PaperClipAI/packages/adapter-utils
Harold KimandPaperclip c4ef3432b3 feat(adapter-utils): instrument sandbox sync with per-stage duration timers
Add tar -> upload -> extract duration timers around the git, workspace
overlay, and asset upload seams in prepareSandboxManagedRuntime, emitted
per artifact + per stage under the existing git_sync/config_sync phase
labels. Each line carries a placeholder transport tag (native|fallback,
default fallback) for later phases to populate. Observability only: no
transport behavior change. Establishes the measurement baseline for
before/after sync performance comparison.

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-07-21 21:02:25 +00: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.