Agent Sandbox Registry

agent-sandbox

Agent Sandbox CLI — 文档中心

English

docs/zh/README.md

Agent Sandbox CLI — 文档中心

abx 是 Agent Sandbox 云端沙箱服务（阿里云函数计算）的命令行客户端：创建与管理沙箱、执行代码与命令、编写与部署模板，并通过 MCP Server 向 IDE Agent 暴露沙箱。本页索引 CLI（@agent-sandbox/cli）的文档。Python SDK 的文档位于 python-sdk 仓库，见 相关 SDK 文档。

设计文档

# 文档 说明
1 CLI 架构 分层、src/ 结构、命令组、输出与退出码、构建 / SEA 二进制 / 发布、一致性契约
2 CLI 命令体系 命令树、全局选项、自然语言创建、OutputManager、AI Friendly 原则
3 MCP Server 7 个 P0 工具定义、会话绑定、STDIO 与 Streamable HTTP 传输、IDE 配置、FC 部署
4 模板目录 官方模板集合形态契约、发布流程、离线校验、模板命令面

汇总索引见 DESIGN.md。仅有英文的维护者文档（移植规则、仓库布局、provider 草案）在该索引中列出，位于 docs/design/ 与 docs/PORTING.md。

用户文档

guide/ — 使用教程与 How-to 指南

文档 说明
快速开始 安装、配置、第一个沙箱
最佳实践 何时使用 --provider、--model、llm_model、凭证和独立二进制
操作指南 每个命令组，以及做这件事时要运行的那一条命令
二进制安装 单文件 abx 二进制（Node SEA），无需 Node.js
提供商 安装、选择并配置沙箱提供商
编写提供商 编写 EPP/1 提供商插件，含 [template] 与从 git 安装
认证配置 API Key / AK-SK 认证与 abx config
CLI 教程 命令行快速上手
模板使用 官方与社区模板使用
模板编写 自定义模板；已有项目用 abx template init --adopt
部署与构建 模板生命周期（template init / --adopt → deploy → create）
端到端模板工作流 从零构建模板到沙箱使用完整指南
MCP 集成 Cursor / Claude Desktop / VS Code 集成
环境变量 沙箱环境变量作用域、注入方式与直接执行语义
故障排查 常见问题与解决方案
Agent Skill 安装与分发 把静态 SKILL.md 指南安装到 Qoder / Claude Code / Cursor / Qwen Code / Codex
Agents API 在沙箱里跑 Codex、Qwen Code，以及之后扩充的 Agent CLI。会话、回合和条目由服务端解析
测试与完成定义 三层验证（单元、差分、真实云 E2E）与完成定义（Definition of Done）
命令与 SDK 对照 abx、Python SDK 与 E2B、OpenSandbox 的命令和方法对照

reference/ — CLI / 配置参考

文档 说明
CLI 命令参考 规范命令树、固定的顶层快捷方式、已移除写法
CLI 参考 所有 CLI 命令速查
配置参考 CLI 环境变量、配置文件、优先级
错误码 E1xxx–E6xxx 错误码与 CLI 退出码

项目规划

文档 说明
设计索引 设计专题索引与实现状态
Python 到 Node 移植 一致性契约与测试台账

快速导航

按角色

按功能

其他资源

相关 SDK 文档

Python SDK、沙箱内 Server SDK 与共享的平台契约的文档位于 python-sdk 仓库：