Add SSH environment support (#4358)
## Thinking Path
> - Paperclip orchestrates AI agents for zero-human companies
> - The environments subsystem already models execution environments,
but before this branch there was no end-to-end SSH-backed runtime path
for agents to actually run work against a remote box
> - That meant agents could be configured around environment concepts
without a reliable way to execute adapter sessions remotely, sync
workspace state, and preserve run context across supported adapters
> - We also need environment selection to participate in normal
Paperclip control-plane behavior: agent defaults, project/issue
selection, route validation, and environment probing
> - Because this capability is still experimental, the UI surface should
be easy to hide and easy to remove later without undoing the underlying
implementation
> - This pull request adds SSH environment execution support across the
runtime, adapters, routes, schema, and tests, then puts the visible
environment-management UI behind an experimental flag
> - The benefit is that we can validate real SSH-backed agent execution
now while keeping the user-facing controls safely gated until the
feature is ready to come out of experimentation
## What Changed
- Added SSH-backed execution target support in the shared adapter
runtime, including remote workspace preparation, skill/runtime asset
sync, remote session handling, and workspace restore behavior after
runs.
- Added SSH execution coverage for supported local adapters, plus remote
execution tests across Claude, Codex, Cursor, Gemini, OpenCode, and Pi.
- Added environment selection and environment-management backend support
needed for SSH execution, including route/service work, validation,
probing, and agent default environment persistence.
- Added CLI support for SSH environment lab verification and updated
related docs/tests.
- Added the `enableEnvironments` experimental flag and gated the
environment UI behind it on company settings, agent configuration, and
project configuration surfaces.
## Verification
- `pnpm exec vitest run
packages/adapters/claude-local/src/server/execute.remote.test.ts
packages/adapters/cursor-local/src/server/execute.remote.test.ts
packages/adapters/gemini-local/src/server/execute.remote.test.ts
packages/adapters/opencode-local/src/server/execute.remote.test.ts
packages/adapters/pi-local/src/server/execute.remote.test.ts`
- `pnpm exec vitest run server/src/__tests__/environment-routes.test.ts`
- `pnpm exec vitest run
server/src/__tests__/instance-settings-routes.test.ts`
- `pnpm exec vitest run ui/src/lib/new-agent-hire-payload.test.ts
ui/src/lib/new-agent-runtime-config.test.ts`
- `pnpm -r typecheck`
- `pnpm build`
- Manual verification on a branch-local dev server:
- enabled the experimental flag
- created an SSH environment
- created a Linux Claude agent using that environment
- confirmed a run executed on the Linux box and synced workspace changes
back
## Risks
- Medium: this touches runtime execution flow across multiple adapters,
so regressions would likely show up in remote session setup, workspace
sync, or environment selection precedence.
- The UI flag reduces exposure, but the underlying runtime and route
changes are still substantial and rely on migration correctness.
- The change set is broad across adapters, control-plane services,
migrations, and UI gating, so review should pay close attention to
environment-selection precedence and remote workspace lifecycle
behavior.
## Model Used
- OpenAI Codex via Paperclip's local Codex adapter, GPT-5-class coding
model with tool use and code execution in the local repo workspace. The
local adapter does not surface a more specific public model version
string in this branch workflow.
## Checklist
- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [ ] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge
2026-04-23 19:15:22 -07:00
|
|
|
import { afterEach, describe, expect, it, vi } from "vitest";
|
|
|
|
|
import * as ssh from "./ssh.js";
|
|
|
|
|
import {
|
|
|
|
|
adapterExecutionTargetUsesManagedHome,
|
Add dedicated environment settings page and test-in-environment (#4798)
## Thinking Path
> - Paperclip orchestrates AI agents for zero-human companies
> - Agents run inside environments (local, SSH, E2B sandbox)
> - Operators need to configure and manage these environments
> - But environment settings were buried inside the general company
settings page, making them hard to find
> - Additionally, when testing an agent from the configuration form, the
test always ran locally regardless of which environment was selected
> - This PR moves environments into a dedicated top-level company
settings section and wires the "Test Environment" button to run inside
the selected environment
> - The benefit is operators can find and manage environments more
easily, and the test button now validates the actual environment the
agent will use
## What Changed
- Added a dedicated `CompanyEnvironments` settings page with its own
route and sidebar entry
- Updated `CompanySettingsSidebar` and `CompanySettingsNav` to include
the new environments section
- Modified the agent test route (`POST /agents/:id/test`) to accept an
optional `environmentId` parameter
- Updated all adapter `test.ts` handlers to resolve and use the
specified execution target environment
- Added `resolveTestExecutionTarget` to `execution-target.ts` for remote
environment test resolution with cwd fallback
- Moved the "Test Environment" button and its feedback display into the
`NewAgent` page footer for better UX flow
## Verification
- `pnpm test` — all existing and new tests pass
- `pnpm typecheck` — clean
- Manual: navigate to Company Settings, confirm "Environments" appears
as a top-level section
- Manual: configure an agent with a non-local environment, click "Test
Environment", confirm the test runs inside that environment
## Risks
- Low risk. UI-only routing change for the settings page. The
test-in-environment change adds an optional parameter with a local
fallback, so existing behavior is preserved when no environment is
specified.
## Model Used
Codex GPT 5.4 high via Paperclip.
## Checklist
- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge
2026-04-29 15:56:13 -07:00
|
|
|
resolveAdapterExecutionTargetCwd,
|
Add SSH environment support (#4358)
## Thinking Path
> - Paperclip orchestrates AI agents for zero-human companies
> - The environments subsystem already models execution environments,
but before this branch there was no end-to-end SSH-backed runtime path
for agents to actually run work against a remote box
> - That meant agents could be configured around environment concepts
without a reliable way to execute adapter sessions remotely, sync
workspace state, and preserve run context across supported adapters
> - We also need environment selection to participate in normal
Paperclip control-plane behavior: agent defaults, project/issue
selection, route validation, and environment probing
> - Because this capability is still experimental, the UI surface should
be easy to hide and easy to remove later without undoing the underlying
implementation
> - This pull request adds SSH environment execution support across the
runtime, adapters, routes, schema, and tests, then puts the visible
environment-management UI behind an experimental flag
> - The benefit is that we can validate real SSH-backed agent execution
now while keeping the user-facing controls safely gated until the
feature is ready to come out of experimentation
## What Changed
- Added SSH-backed execution target support in the shared adapter
runtime, including remote workspace preparation, skill/runtime asset
sync, remote session handling, and workspace restore behavior after
runs.
- Added SSH execution coverage for supported local adapters, plus remote
execution tests across Claude, Codex, Cursor, Gemini, OpenCode, and Pi.
- Added environment selection and environment-management backend support
needed for SSH execution, including route/service work, validation,
probing, and agent default environment persistence.
- Added CLI support for SSH environment lab verification and updated
related docs/tests.
- Added the `enableEnvironments` experimental flag and gated the
environment UI behind it on company settings, agent configuration, and
project configuration surfaces.
## Verification
- `pnpm exec vitest run
packages/adapters/claude-local/src/server/execute.remote.test.ts
packages/adapters/cursor-local/src/server/execute.remote.test.ts
packages/adapters/gemini-local/src/server/execute.remote.test.ts
packages/adapters/opencode-local/src/server/execute.remote.test.ts
packages/adapters/pi-local/src/server/execute.remote.test.ts`
- `pnpm exec vitest run server/src/__tests__/environment-routes.test.ts`
- `pnpm exec vitest run
server/src/__tests__/instance-settings-routes.test.ts`
- `pnpm exec vitest run ui/src/lib/new-agent-hire-payload.test.ts
ui/src/lib/new-agent-runtime-config.test.ts`
- `pnpm -r typecheck`
- `pnpm build`
- Manual verification on a branch-local dev server:
- enabled the experimental flag
- created an SSH environment
- created a Linux Claude agent using that environment
- confirmed a run executed on the Linux box and synced workspace changes
back
## Risks
- Medium: this touches runtime execution flow across multiple adapters,
so regressions would likely show up in remote session setup, workspace
sync, or environment selection precedence.
- The UI flag reduces exposure, but the underlying runtime and route
changes are still substantial and rely on migration correctness.
- The change set is broad across adapters, control-plane services,
migrations, and UI gating, so review should pay close attention to
environment-selection precedence and remote workspace lifecycle
behavior.
## Model Used
- OpenAI Codex via Paperclip's local Codex adapter, GPT-5-class coding
model with tool use and code execution in the local repo workspace. The
local adapter does not surface a more specific public model version
string in this branch workflow.
## Checklist
- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [ ] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge
2026-04-23 19:15:22 -07:00
|
|
|
runAdapterExecutionTargetShellCommand,
|
|
|
|
|
} from "./execution-target.js";
|
|
|
|
|
|
|
|
|
|
describe("runAdapterExecutionTargetShellCommand", () => {
|
|
|
|
|
afterEach(() => {
|
|
|
|
|
vi.restoreAllMocks();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("quotes remote shell commands with the shared SSH quoting helper", async () => {
|
|
|
|
|
const runSshCommandSpy = vi.spyOn(ssh, "runSshCommand").mockResolvedValue({
|
|
|
|
|
stdout: "",
|
|
|
|
|
stderr: "",
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
await runAdapterExecutionTargetShellCommand(
|
|
|
|
|
"run-1",
|
|
|
|
|
{
|
|
|
|
|
kind: "remote",
|
|
|
|
|
transport: "ssh",
|
|
|
|
|
remoteCwd: "/srv/paperclip/workspace",
|
|
|
|
|
spec: {
|
|
|
|
|
host: "ssh.example.test",
|
|
|
|
|
port: 22,
|
|
|
|
|
username: "ssh-user",
|
|
|
|
|
remoteCwd: "/srv/paperclip/workspace",
|
|
|
|
|
remoteWorkspacePath: "/srv/paperclip/workspace",
|
|
|
|
|
privateKey: null,
|
|
|
|
|
knownHosts: null,
|
|
|
|
|
strictHostKeyChecking: true,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
`printf '%s\\n' "$HOME" && echo "it's ok"`,
|
|
|
|
|
{
|
|
|
|
|
cwd: "/tmp/local",
|
|
|
|
|
env: {},
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
expect(runSshCommandSpy).toHaveBeenCalledWith(
|
|
|
|
|
expect.objectContaining({
|
|
|
|
|
host: "ssh.example.test",
|
|
|
|
|
username: "ssh-user",
|
|
|
|
|
}),
|
|
|
|
|
`sh -lc ${ssh.shellQuote(`printf '%s\\n' "$HOME" && echo "it's ok"`)}`,
|
|
|
|
|
expect.any(Object),
|
|
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("returns a timedOut result when the SSH shell command times out", async () => {
|
|
|
|
|
vi.spyOn(ssh, "runSshCommand").mockRejectedValue(Object.assign(new Error("timed out"), {
|
|
|
|
|
code: "ETIMEDOUT",
|
|
|
|
|
stdout: "partial stdout",
|
|
|
|
|
stderr: "partial stderr",
|
|
|
|
|
signal: "SIGTERM",
|
|
|
|
|
}));
|
|
|
|
|
const onLog = vi.fn(async () => {});
|
|
|
|
|
|
|
|
|
|
const result = await runAdapterExecutionTargetShellCommand(
|
|
|
|
|
"run-2",
|
|
|
|
|
{
|
|
|
|
|
kind: "remote",
|
|
|
|
|
transport: "ssh",
|
|
|
|
|
remoteCwd: "/srv/paperclip/workspace",
|
|
|
|
|
spec: {
|
|
|
|
|
host: "ssh.example.test",
|
|
|
|
|
port: 22,
|
|
|
|
|
username: "ssh-user",
|
|
|
|
|
remoteCwd: "/srv/paperclip/workspace",
|
|
|
|
|
remoteWorkspacePath: "/srv/paperclip/workspace",
|
|
|
|
|
privateKey: null,
|
|
|
|
|
knownHosts: null,
|
|
|
|
|
strictHostKeyChecking: true,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
"sleep 10",
|
|
|
|
|
{
|
|
|
|
|
cwd: "/tmp/local",
|
|
|
|
|
env: {},
|
|
|
|
|
onLog,
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
expect(result).toMatchObject({
|
|
|
|
|
exitCode: null,
|
|
|
|
|
signal: "SIGTERM",
|
|
|
|
|
timedOut: true,
|
|
|
|
|
stdout: "partial stdout",
|
|
|
|
|
stderr: "partial stderr",
|
|
|
|
|
});
|
|
|
|
|
expect(onLog).toHaveBeenCalledWith("stdout", "partial stdout");
|
|
|
|
|
expect(onLog).toHaveBeenCalledWith("stderr", "partial stderr");
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("returns the SSH process exit code for non-zero remote command failures", async () => {
|
|
|
|
|
vi.spyOn(ssh, "runSshCommand").mockRejectedValue(Object.assign(new Error("non-zero exit"), {
|
|
|
|
|
code: 17,
|
|
|
|
|
stdout: "partial stdout",
|
|
|
|
|
stderr: "partial stderr",
|
|
|
|
|
signal: null,
|
|
|
|
|
}));
|
|
|
|
|
const onLog = vi.fn(async () => {});
|
|
|
|
|
|
|
|
|
|
const result = await runAdapterExecutionTargetShellCommand(
|
|
|
|
|
"run-3",
|
|
|
|
|
{
|
|
|
|
|
kind: "remote",
|
|
|
|
|
transport: "ssh",
|
|
|
|
|
remoteCwd: "/srv/paperclip/workspace",
|
|
|
|
|
spec: {
|
|
|
|
|
host: "ssh.example.test",
|
|
|
|
|
port: 22,
|
|
|
|
|
username: "ssh-user",
|
|
|
|
|
remoteCwd: "/srv/paperclip/workspace",
|
|
|
|
|
remoteWorkspacePath: "/srv/paperclip/workspace",
|
|
|
|
|
privateKey: null,
|
|
|
|
|
knownHosts: null,
|
|
|
|
|
strictHostKeyChecking: true,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
"false",
|
|
|
|
|
{
|
|
|
|
|
cwd: "/tmp/local",
|
|
|
|
|
env: {},
|
|
|
|
|
onLog,
|
|
|
|
|
},
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
expect(result).toMatchObject({
|
|
|
|
|
exitCode: 17,
|
|
|
|
|
signal: null,
|
|
|
|
|
timedOut: false,
|
|
|
|
|
stdout: "partial stdout",
|
|
|
|
|
stderr: "partial stderr",
|
|
|
|
|
});
|
|
|
|
|
expect(onLog).toHaveBeenCalledWith("stdout", "partial stdout");
|
|
|
|
|
expect(onLog).toHaveBeenCalledWith("stderr", "partial stderr");
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("keeps managed homes disabled for both local and SSH targets", () => {
|
|
|
|
|
expect(adapterExecutionTargetUsesManagedHome(null)).toBe(false);
|
|
|
|
|
expect(adapterExecutionTargetUsesManagedHome({
|
|
|
|
|
kind: "remote",
|
|
|
|
|
transport: "ssh",
|
|
|
|
|
remoteCwd: "/srv/paperclip/workspace",
|
|
|
|
|
spec: {
|
|
|
|
|
host: "ssh.example.test",
|
|
|
|
|
port: 22,
|
|
|
|
|
username: "ssh-user",
|
|
|
|
|
remoteCwd: "/srv/paperclip/workspace",
|
|
|
|
|
remoteWorkspacePath: "/srv/paperclip/workspace",
|
|
|
|
|
privateKey: null,
|
|
|
|
|
knownHosts: null,
|
|
|
|
|
strictHostKeyChecking: true,
|
|
|
|
|
},
|
|
|
|
|
})).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
});
|
Add dedicated environment settings page and test-in-environment (#4798)
## Thinking Path
> - Paperclip orchestrates AI agents for zero-human companies
> - Agents run inside environments (local, SSH, E2B sandbox)
> - Operators need to configure and manage these environments
> - But environment settings were buried inside the general company
settings page, making them hard to find
> - Additionally, when testing an agent from the configuration form, the
test always ran locally regardless of which environment was selected
> - This PR moves environments into a dedicated top-level company
settings section and wires the "Test Environment" button to run inside
the selected environment
> - The benefit is operators can find and manage environments more
easily, and the test button now validates the actual environment the
agent will use
## What Changed
- Added a dedicated `CompanyEnvironments` settings page with its own
route and sidebar entry
- Updated `CompanySettingsSidebar` and `CompanySettingsNav` to include
the new environments section
- Modified the agent test route (`POST /agents/:id/test`) to accept an
optional `environmentId` parameter
- Updated all adapter `test.ts` handlers to resolve and use the
specified execution target environment
- Added `resolveTestExecutionTarget` to `execution-target.ts` for remote
environment test resolution with cwd fallback
- Moved the "Test Environment" button and its feedback display into the
`NewAgent` page footer for better UX flow
## Verification
- `pnpm test` — all existing and new tests pass
- `pnpm typecheck` — clean
- Manual: navigate to Company Settings, confirm "Environments" appears
as a top-level section
- Manual: configure an agent with a non-local environment, click "Test
Environment", confirm the test runs inside that environment
## Risks
- Low risk. UI-only routing change for the settings page. The
test-in-environment change adds an optional parameter with a local
fallback, so existing behavior is preserved when no environment is
specified.
## Model Used
Codex GPT 5.4 high via Paperclip.
## Checklist
- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge
2026-04-29 15:56:13 -07:00
|
|
|
|
|
|
|
|
describe("resolveAdapterExecutionTargetCwd", () => {
|
|
|
|
|
const sshTarget = {
|
|
|
|
|
kind: "remote" as const,
|
|
|
|
|
transport: "ssh" as const,
|
|
|
|
|
remoteCwd: "/srv/paperclip/workspace",
|
|
|
|
|
spec: {
|
|
|
|
|
host: "ssh.example.test",
|
|
|
|
|
port: 22,
|
|
|
|
|
username: "ssh-user",
|
|
|
|
|
remoteCwd: "/srv/paperclip/workspace",
|
|
|
|
|
remoteWorkspacePath: "/srv/paperclip/workspace",
|
|
|
|
|
privateKey: null,
|
|
|
|
|
knownHosts: null,
|
|
|
|
|
strictHostKeyChecking: true,
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
it("falls back to the remote cwd when no adapter cwd is configured", () => {
|
|
|
|
|
expect(resolveAdapterExecutionTargetCwd(sshTarget, "", "/Users/host/repo/server")).toBe(
|
|
|
|
|
"/srv/paperclip/workspace",
|
|
|
|
|
);
|
|
|
|
|
expect(resolveAdapterExecutionTargetCwd(sshTarget, " ", "/Users/host/repo/server")).toBe(
|
|
|
|
|
"/srv/paperclip/workspace",
|
|
|
|
|
);
|
|
|
|
|
expect(resolveAdapterExecutionTargetCwd(sshTarget, null, "/Users/host/repo/server")).toBe(
|
|
|
|
|
"/srv/paperclip/workspace",
|
|
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("preserves an explicit adapter cwd when one is configured", () => {
|
|
|
|
|
expect(
|
|
|
|
|
resolveAdapterExecutionTargetCwd(
|
|
|
|
|
sshTarget,
|
|
|
|
|
"/srv/paperclip/custom-agent-dir",
|
|
|
|
|
"/Users/host/repo/server",
|
|
|
|
|
),
|
|
|
|
|
).toBe("/srv/paperclip/custom-agent-dir");
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("keeps the local fallback cwd for local targets", () => {
|
|
|
|
|
expect(resolveAdapterExecutionTargetCwd(null, "", "/Users/host/repo/server")).toBe(
|
|
|
|
|
"/Users/host/repo/server",
|
|
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
});
|