@earendil-works/pi-env

中文文档
1.5.2发布于 2026/11/10MITTypeScriptES Module构建来源已验证近 30 天下载 11.5万

Remote execution environments for Pi Durable: a small daemon deployed over SSH and its ExecutionEnv client

原始使用文档

@earendil-works/pi-env

Remote execution environments for Pi Durable: an agent's tools run on another machine, usually over SSH, while the Durable worker, its storage and credentials stay local.

  • pi-env (daemon/): a small Rust program that runs on the remote machine. It speaks a framed protocol on stdin and stdout (docs/protocol.md) and performs file operations and commands there.
  • RemoteExecutionEnv: a Durable ExecutionEnv that talks to the daemon through a Connection. Its results match NodeExecutionEnv running on the remote machine; only error messages may differ (docs/semantics.md).
import { acceptHostKey, connectSsh, RemoteExecutionEnv, scanHostKey, sshConnection } from "@earendil-works/pi-env";

const target = { host: "gpu-box", knownHostsFile: "/data/ssh/known_hosts", hostKeyAlias: "pi-env-gpu" };
// Once: show the host's key fingerprint to the owner, who compares it out of band and accepts it.
const { lines, fingerprints } = await scanHostKey(target);
await acceptHostKey(target, lines);

// Detects the remote system, deploys the daemon if missing (named by its SHA-256 and verified before every start),
// and returns a connection that starts it over ssh.
const { connection } = await connectSsh(target);
const env = new RemoteExecutionEnv({ connection, id: "pi-env:gpu", cwd: "/home/me/project" });

// Or lazily: nothing happens until the first operation, which detects, deploys and connects. A failure (no network,
// untrusted host key) is that operation's error, and the next operation tries again.
const lazy = sshConnection(target);
const lazyEnv = new RemoteExecutionEnv({ connection: lazy.connection, id: "pi-env:gpu", cwd: "/home/me/project" });

The package ships the daemon for every supported remote system in bin/. ssh runs with BatchMode, strict host-key checking against the application's own known-hosts file under a fixed alias, no forwarding of any kind, no shared connections or configured commands, and without forwarding the local locale. On Windows, detection and deployment go through PowerShell, and the daemon starts through the server's default shell (cmd.exe or PowerShell).

env.listFiles(path, options, context) lists the tree below a directory in the daemon, as fd --hidden --exclude .git does without following symbolic links: files, directories and links as relative / paths, skipping what git ignores inside work trees, bounded by maxEntries, maxBytes and timeoutMs with a truncated flag, and stopped by aborting the context. It is Durable's optional ExecutionEnv.listFiles. A daemon released before it reports not_supported (hello.features lacks listFiles), and callers fall back to their own walk. For local sessions, LocalExecutionEnv is NodeExecutionEnv plus listFiles through a daemon on the same machine:

const local = new Connection({ command: [localDaemon()] }); // owned by the caller; close() it at shutdown
const env = new LocalExecutionEnv({ cwd: "/home/me/project", connection: local });
const listing = await env.listFiles(".", { exclude: ["node_modules"] }, context);
// { ok: true, value: { entries: [{ path: "src", kind: "directory" }, { path: "src/a.ts", kind: "file" }], truncated } }

nodePlatform(await connection.info()) gives the remote system in Node's names (win32, darwin, x64, arm64), as process.platform and process.arch spell them.

openTerminal(connection, options) runs a program, by default the user's login shell, in a pseudo-terminal of the daemon: raw output, input, resizing and its exit code, for interactive terminals. localDaemon() is the daemon for this machine, for terminals without SSH (new Connection({ command: [localDaemon()] })). Terminals are not supported on Windows yet.

openProcess(connection, options) runs a program with plain pipes, for programs that speak a protocol on stdin and stdout, such as an MCP server: write() and closeStdin() for its input, raw stdout and stderr bytes through onStdout and onStderr, close() to kill its process group, and exited for its exit code. When the program exits, what it started in its process group is killed too, so a wrapper such as npx leaves nothing running. Nothing is echoed, translated or merged, unlike a terminal; it works on every supported system. A daemon released before it fails the open with not_supported. argv runs as an exec argv command does: on Windows, batch files such as npx.cmd are refused, as Node refuses them without a shell, so callers start them through cmd.exe.

const server = await openProcess(connection, {
    cwd: "/home/me/project",
    argv: ["npx", "-y", "@modelcontextprotocol/server-filesystem", "."],
    onStdout: (bytes) => parser.push(bytes),
});
server.write(`${JSON.stringify(initialize)}\n`);

Supported remote systems: Linux, macOS, Android (Termux) and Windows, on x86-64 and arm64. On Windows, string commands run through Git Bash as NodeExecutionEnv runs them there; argv commands run directly.

Development

npm run build:daemon builds the daemon with Cargo; the tests talk to daemon/target/debug/pi-env over a pipe, or to the binary named by PI_ENV_DAEMON (CI tests the release builds this way). They run Durable's env conformance suite against RemoteExecutionEnv and compare random operation sequences and Durable's tools against NodeExecutionEnv on the same machine. test/ssh-external.test.ts runs the suite over a real SSH server when PI_ENV_SSH_HOST is set.

版本与发布记录

@earendil-works/pi-env 共发布 10 个版本,首次发布于 2026/10/06;过去 12 个月发布了 10 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.5.2latest2026/11/103 天前
1.5.12026/11/103 天前
1.5.02026/11/0211 天前
1.4.02026/10/2222 天前
1.3.02026/10/1628 天前
1.2.02026/10/131 个月前

关于 @earendil-works/pi-env 的常见问题

@earendil-works/pi-env 是什么?

Remote execution environments for Pi Durable: a small daemon deployed over SSH and its ExecutionEnv client

如何安装 @earendil-works/pi-env?

在项目目录运行 npm install @earendil-works/pi-env,或使用 pnpm add / yarn add / bun add。

@earendil-works/pi-env 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@earendil-works/pi-env 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@earendil-works/pi-env 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.19.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@earendil-works/pi-env 可以商用吗?

@earendil-works/pi-env 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@earendil-works/pi-env 的下载量有多少?

根据 npm 官方下载统计,@earendil-works/pi-env 在 2026/10/13 – 2026/11/11 这 30 天内被下载 114,583 次,日均约 3,819 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@earendil-works/pi-env 还在维护吗?

最新版本 1.5.2 发布于 2026/11/10(3 天前);至今共发布 10 个版本,其中过去 12 个月发布了 10 个;首次发布于 2026/10/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。