跳到正文
浏览文档

接口

命令行接口

使用彼此独立的管理、运行时和可观测性命令行客户端。

本页内容+

选择客户端

Ephemeral Sandbox 有意不提供组合式 CLI。每个可执行文件只暴露一种固定权限,并通过已认证网关发送语义请求。

管理 CLI

sandbox-manager-cli

用于宿主机发现、生命周期、压缩和导出的八项操作。

打开参考文档

运行时 CLI

sandbox-runtime-cli --sandbox-id ID

用于命令会话、文件和归因的七项操作。

打开参考文档

可观测性 CLI

sandbox-observability-cli

用于健康状态、遥测、资源和层的五项只读操作。

打开参考文档

第一组命令

列出管理器已知的沙箱,在其中运行命令,然后检查其在线状态。

Shell
sandbox-manager-cli list_sandboxes
sandbox-runtime-cli --sandbox-id ID exec_command pwd
sandbox-observability-cli snapshot --sandbox-id ID

全局选项

选项客户端用途
--gateway-socket HOST:PORT全部覆盖网关发现结果。
--gateway-auth-token TOKEN全部覆盖令牌发现结果。
--progress管理将网关日志行流式写入 stderr,创建沙箱时尤其有用。
--sandbox-id ID运行时选择必需的沙箱网关范围。
--request-id VALUE运行时提供稳定的请求标识,用于关联和归因。

认证与连接

默认情况下,bin/ 中的仓库启动器会从 ~/.ephemeral-sandbox/gateway.token 加载 SANDBOX_GATEWAY_AUTH_TOKEN。可用 SANDBOX_GATEWAY_TOKEN_FILE 选择由服务管理的路径。令牌文件不得对同组用户或其他用户开放。

Shell
bin/sandbox-gateway-token ensure
bin/sandbox-manager-cli list_sandboxes

直接运行二进制文件时,也会从参数或环境变量中发现相同连接。只有在受控自动化中才使用显式令牌参数,因为命令参数可能被其他进程看到或留在 shell 历史中。

参数与 shell 引号

全局选项可以放在操作前后;操作参数则遵循该操作生成的用法。请为命令文本、文件内容和编辑 JSON 加引号,确保本地 shell 将它们作为单一值原样传递。

Shell
sandbox-runtime-cli --sandbox-id ID exec_command 'printf "%s\n" ready'
sandbox-runtime-cli --sandbox-id ID file_edit --path notes.txt \
  --edits '[{"old_string":"draft","new_string":"ready"}]'

输出与退出状态

成功时向 stdout 写入一份 JSON 响应。远程和传输错误向 stderr 写入 JSON envelope;本地语法、参数校验和配置错误也使用 stderr。

退出码含义
0帮助或操作成功。
1传输或远程操作失败。
2本地语法、校验或配置失败。

生成的帮助信息

每个二进制文件根据目录生成的帮助,是已安装语法的最终依据。目录帮助列出操作;操作帮助包含说明、用法、参数类型、默认值、示例和相关操作。

Shell
sandbox-manager-cli help create_sandbox
sandbox-runtime-cli --sandbox-id ID help exec_command
sandbox-observability-cli help layerstack

18 个结果