Files
vibebox/README.zh.md
2026-02-09 00:28:20 -05:00

8.1 KiB
Raw Permalink Blame History

VibeBox logo

用于安全运行 coding agents 的超高速开源沙盒。

Crates.io MIT licensed Build Status

简体中文 | English

VibeBox 是一个按项目划分的 micro-VM 沙盒,用于在 macOS 上运行 coding agents基于 Apple Virtualization Framework 它面向 日常使用 工作流优化:快速热启动、显式挂载、可复用会话。

适合谁: 在 macOS 上使用 coding agents并且既想要真实隔离又不想牺牲日常效率的人。

快速事实: 在我的 M3 上,热启动通常 <5s(因机器/缓存而异);首次运行会下载并初始化 Debian 基础镜像(受网络影响)。

安全模型: Linux 来宾 VM + vibebox.toml 显式挂载白名单(默认仅项目目录,其它均需显式允许)。

  • 几秒进入/附加: vibebox 直接进入当前仓库的可复用沙盒
  • 默认按项目范围: 显式挂载 + 改动限制在仓库内repo 优先,其他需 allowlist
  • 会话化: 多实例 + 会话管理(复用、多终端、清理)

快速演示

# 在任意仓库内
cd my-project
vibebox

你大致会看到:

vibebox: starting (session: my-project)
vibebox: attaching...
vibecoder@vibebox:~/my-project$

VibeBox Terminal UI


我为什么做 VibeBox

我每天都在用 coding agents也希望它们有一个真实的 shell但不想把宿主机直接交出去。 权限收紧会被不停的确认打断;权限放开又担心误删文件、触及密钥,或者跑出仓库边界。

VibeBox 是中间方案:按项目隔离、硬 VM 边界、快速回到工作状态、显式挂载。它适合把 agent 当成日常工具,而不是把安全变成负担。

为什么是 micro-VM而不是容器

容器很好用。VibeBox 并不是用来替代 Docker/devcontainers 去构建服务。

我更想要的是在 macOS 上适合 agent 的 VM 默认形态:

  • 默认是 guest-kernel 隔离边界: 让 agent 跑任意命令时,“安全模式”是 Linux 来宾而不是宿主机。
  • 会话是第一等公民: 按项目附加/复用,多终端进入同一沙盒,可靠清理,避免孤儿环境。
  • 显式挂载白名单作为主要 UX 默认仅项目目录,其它都需显式允许。
  • 最少的每项目配置: 你可以用 compose/devcontainers 实现一部分,但我想要的是一个命令,在不同仓库间直接工作,不必维护容器配置来获得基础“安全 shell”体验。

对比

下面是我为什么没有直接用现成方案的原因:

  • vibe:非常方便,“零配置、直接用”做得很好。但 VibeBox 走的是另一条路:按项目配置 + 会话 + 多实例生命周期。
  • QEMU:很强大,但配置面太大了。日常当沙箱用,它不像是“进到 repo 就能用”,更像是你得先把它当成一个项目来折腾。
  • Docker / devcontainers / devpods:生态很成熟。我的痛点不在启动时间,而是日常保持 safe-by-default挂载白名单、密钥暴露、附加/复用、清理)的开销,不想为基础 workflow 在每个项目维护容器配置。

这就是我做 VibeBox 的原因:我想要一个按项目隔离的沙箱,进入快(直接 vibebox),支持真实配置 + 会话,同时保持硬隔离边界。

安装

# YOLO一键安装
curl -fsSL https://raw.githubusercontent.com/robcholz/vibebox/main/install | bash

# Cargo
cargo install vibebox

# 或者手动安装
curl -LO https://github.com/robcholz/vibebox/releases/download/latest/vibebox-macos-arm64.zip
unzip vibebox-macos-arm64.zip
mkdir -p ~/.local/bin
mv vibebox ~/.local/bin
export PATH="$HOME/.local/bin:$PATH"

系统要求

  • Apple Silicon 的 macOSVibeBox 使用了 Apple 的虚拟化 API

首次运行

第一次执行 vibebox 会下载 Debian 基础镜像并完成初始化。之后每个项目的实例会复用缓存的基础镜像, 启动会快很多。

文档

快速开始

cd /path/to/your/project
vibebox

第一次运行时如果项目目录里缺少配置VibeBox 会自动创建 vibebox.toml(放在项目根目录),并创建 .vibebox/ 用来保存实例数据。

配置(vibebox.toml

默认情况下,vibebox.toml 位于项目根目录。你可以用 vibebox -c path/to/vibebox.toml 或设置 VIBEBOX_CONFIG_PATH 环境变量来覆盖路径,但配置文件必须仍然位于项目目录内部。

默认配置(缺失时会自动生成):

[box]
cpu_count = 2
ram_mb = 2048
disk_gb = 5
mounts = [
    "~/.codex:~/.codex:read-write",
    "~/.claude:~/.claude:read-write",
]

[supervisor]
auto_shutdown_ms = 20000

注意:disk_gb 只在「首次创建实例磁盘」时生效。之后如果你改了它,需要运行 vibebox reset 重新创建磁盘。

挂载Mounts

  • 你的项目会以读写方式挂载到 ~/<project-name>,并且 shell 会默认从那里启动。
  • 如果项目里存在 .git 目录VM 内会用 tmpfs 把它遮住,避免你在 guest 里误操作改到 Git 元数据。
  • 额外挂载通过 box.mounts 配置,格式为 host:guest[:read-only|read-write]
  • Host 路径支持 ~ 展开guest 的相对路径会被视为 /root/<path>
  • guest 路径如果用了 ~,会为了方便被链接到 /home/<ssh-user> 下。你可以运行 vibebox explain 查看最终解析后的 host/guest 映射关系。

CLI 命令

vibebox             # 启动或连接当前项目的 VM
vibebox list        # 列出已知的项目会话
vibebox reset       # 删除当前项目的 .vibebox下一次运行会重新创建
vibebox purge-cache # 删除全局缓存(~/.cache/vibebox
vibebox explain     # 显示挂载与网络信息

在 VM 内部

  • 默认 SSH 用户:vibecoder
  • 主机名:vibebox
  • 基础镜像初始化会安装:构建工具、gitcurlripgrepopenssh-serversudo
  • 首次登录时VibeBox 会安装 mise,并尽力配置 uvnode@openai/codex@anthropic-ai/claude-code 等工具best-effort视网络和环境而定
  • Shell 里有两个别名::help:exit

状态与缓存

  • 项目级状态在 .vibebox/实例磁盘、SSH key、日志、manager socket/pidvibebox reset 会移除它。
  • 全局缓存在 ~/.cache/vibebox(基础镜像 + 共享 guest 缓存)。vibebox purge-cache 会清空它。
  • 会话索引在 ~/.vibebox/sessions,可以通过 vibebox list 查看。

参与贡献

如果你想参与贡献 VibeBox请先阅读 贡献指南,再提交 Pull Request。

FAQ

它和其它 Sandboxes 有什么不同?

VibeBox 追求的是:本地、可复现、启动快、流程简单。主要差异点:

  • 在我的 M3 上,热启动通常 <5s,可以非常快地回到工作状态。
  • 一个命令——vibebox——直接把你带进沙盒(从你的项目目录启动)。
  • 配置集中在 vibebox.tomlCPU / 内存 / 磁盘大小 / 挂载都能一眼看懂、随手改。
  • 会话是第一等公民:复用、多终端、清理。

特别鸣谢

vibe by lynaghk。

以及 Rust 社区。没有你们丰富的 crates 生态和优秀的工具链(比如 crates.io 这个项目不可能这么顺利Rust教。


在 X 上关注我 X.com