diff --git a/packages/plugins/sandbox-providers/SANDBOX-REQUIREMENTS.md b/packages/plugins/sandbox-providers/SANDBOX-REQUIREMENTS.md new file mode 100644 index 00000000000..1d762085a3a --- /dev/null +++ b/packages/plugins/sandbox-providers/SANDBOX-REQUIREMENTS.md @@ -0,0 +1,70 @@ +# Sandbox Runtime Requirements + +This document states the sandbox environment as a contract. The sandbox owner +must meet this contract. The Paperclip runtime does not build the environment at +exec time. The environment is a requirement, not a build step. + +This document states requirements. It does not state build steps. + +## Required on PATH + +- `node` must be installed and on the PATH. +- Each agent CLI that the run uses must be installed and on the PATH. The set of + agent CLIs includes `claude`, `codex`, `gemini`, and similar CLIs. +- The owner installs only the CLIs that the run uses. The owner does not need to + install a CLI that no run uses. + +## Runtime dependencies + +The sandbox execution and synchronization paths need more than `node` and the +agent CLIs. The owner must also supply these: + +- A POSIX shell as `sh`, normally `/bin/sh`. The runtime runs each command with + `sh -c