on main help sign in
doc: update
commit7065144e6fd7f99f2d76be8eaf0628619425b2c6 authorrobcholz <84130577+robcholz@users.noreply.github.com> dateMon 9 Feb 2026, 00:28 (8 months ago) parent5e95c09
2 files changed+114−51
README.md+63−34 README.zh.md+51−17
README.md+63−34
@@ -5,7 +5,7 @@
55 </picture>
66 </a>
77</p>
8−<p align="center">Your ultrafast open source AI sandbox.</p>
8+<p align="center">an ultrafast, open-source sandbox for running coding agents safely.</p>
99
1010<p align="center">
1111 <a href="https://crates.io/crates/vibebox">
@@ -24,45 +24,77 @@
2424 <a href="README.zh.md">简体中文</a>
2525</p>
2626
27−**VibeBox is a per-project micro-VM sandbox for coding agents on macOS (Apple Virtualization Framework), fast to enter,
28−configurable, and built around sessions.**
27+**VibeBox is a per-project micro-VM sandbox for running coding agents on macOS (Apple Virtualization Framework).**
28+It’s optimized for a *daily-driver* workflow: fast warm re-entry, explicit mounts, and reusable sessions.
2929
30−- **Enter in seconds:** `vibebox` drops you into a reusable sandbox for the current repo
31−- **Project-scoped:** explicit mounts + repo-contained changes
32−- **Sessioned:** multi-instance + session management (reuse, multiple terminals, cleanup)
30+**Who it’s for:** macOS users running coding agents who want real isolation without giving up a fast daily workflow.
31+
32+**Quick facts:** warm re-entry is typically **<5s** on my M3 (varies by machine/cache); first run downloads and
33+provisions a Debian base image (network dependent).
34+
35+**Security model:** Linux guest VM with explicit mount allowlists from `vibebox.toml` (repo-first, everything else
36+opt-in).
37+
38+- **enter/attach in seconds:** `vibebox` drops you into a reusable sandbox for the current repo
39+- **project-scoped by default:** explicit mounts + repo-contained changes (repo-first, everything else is allowlisted)
40+- **sessioned:** multi-instance + session management (reuse, multiple terminals, cleanup)
3341
3442### Quick Demo
3543
3644```bash
37−# 1) from any repo
45+# from any repo
3846cd my-project
3947vibebox
4048```
4149
50+What you should see (roughly):
51+
52+```text
53+vibebox: starting (session: my-project)
54+vibebox: attaching...
55+vibecoder@vibebox:~/my-project$
56+```
57+
4258[![VibeBox Terminal UI](docs/screenshot.png)](https://vibebox.robcholz.com)
4359
4460---
4561
4662### Why I built VibeBox
4763
48−I use agents like Codex and CC a lot, but I always felt uneasy running them directly on my host machine. If I lock
49−things
50−down, I get interrupted by constant “are you sure?” prompts. If I loosen it up, I worry the agent might touch the
51−wrong files or run something I didn’t intend.
64+I use coding agents daily, and I wanted to give them a real shell without handing them my host machine.
65+Lock things down and you get nonstop confirmations; loosen it up and you worry about deleting files, touching secrets,
66+or wandering outside the repo.
5267
53−I wanted something that feels as frictionless as giving an agent a real shell, but with a hard isolation boundary. So I
54−built VibeBox: a per-project micro-VM sandbox that starts fast, keeps changes contained to the repo, and lets me iterate
55−without babysitting permissions.
68+VibeBox is the middle ground: a per-repo sandbox with a hard VM boundary, fast re-entry, and explicit mounts. It’s built
69+to be “always on” for agent work without turning safety into a chore.
70+
71+### Why a micro-VM (vs containers)?
72+
73+Containers are great. VibeBox isn’t trying to replace Docker/devcontainers for building services.
74+
75+I specifically wanted a VM-shaped default for agent workflows on macOS:
76+
77+- **guest-kernel isolation boundary by default:** when I’m letting an agent run arbitrary commands, I want “safe mode”
78+ to
79+ be a Linux guest, not my host.
80+- **sessions as a first-class workflow:** attach/reuse per repo, multiple terminals into the same sandbox, reliable
81+ cleanup to avoid orphan environments.
82+- **explicit mount allowlists as the primary UX:** repo-scoped by default; anything else is an explicit decision.
83+- **minimal per-repo setup:** you *can* reproduce parts of this with compose/devcontainers, but I wanted a single
84+ command
85+ that works repo-to-repo without maintaining container configs for the basic “safe shell” workflow.
5686
5787### Comparison
5888
5989Here’s why I didn’t just use existing options:
6090
61−- **vibe**: super convenient, but it’s too minimal for what I need. It lacks basic configuration, and it doesn’t give me
62− the multi-instance + session management my workflow wants.
91+- **vibe**: super convenient and nails “zero-config, just go”. VibeBox is intentionally on a different axis: per-repo
92+ config + sessions + multi-instance lifecycle.
6393- **QEMU**: powerful, but the configuration surface area is huge. For day-to-day sandboxing it’s not “open a repo and
6494 go” — it’s a project on its own.
65−- **Docker / devcontainers**: great ecosystem, but for daily use it feels heavy.
95+- **Docker / devcontainers / devpods**: great ecosystem. My friction wasn’t raw startup time, it was the day-to-day
96+ overhead of keeping per-repo agent sandboxes *safe-by-default* (mount allowlists, secrets exposure, attach/reuse,
97+ cleanup) without maintaining container configs per repo for the basic workflow.
6698
6799That’s what pushed me to build **VibeBox**: I wanted a per-project sandbox that’s fast to enter (just `vibebox`),
68100supports real configuration + sessions, and keeps a hard isolation boundary.
@@ -70,13 +102,13 @@ supports real configuration + sessions, and keeps a hard isolation boundary.
70102### Installation
71103
72104```bash
73−# YOLO
105+# install script
74106curl -fsSL https://raw.githubusercontent.com/robcholz/vibebox/main/install | bash
75107
76−# Package managers
108+# package managers
77109cargo install vibebox
78110
79−# Or manually
111+# manual install
80112curl -LO https://github.com/robcholz/vibebox/releases/download/latest/vibebox-macos-arm64.zip
81113unzip vibebox-macos-arm64.zip
82114mkdir -p ~/.local/bin
@@ -86,7 +118,7 @@ export PATH="$HOME/.local/bin:$PATH"
86118
87119**Requirements**
88120
89−- macOS on Apple Silicon (Vibebox uses Apple's virtualization APIs).
121+- macOS on Apple Silicon (VibeBox uses Apple's virtualization APIs).
90122
91123**First Run**
92124
@@ -102,7 +134,7 @@ cd /path/to/your/project
102134vibebox
103135```
104136
105−On first run, Vibebox creates `vibebox.toml` in your project (if missing) and a `.vibebox/` directory for instance data.
137+On first run, VibeBox creates `vibebox.toml` in your project (if missing) and a `.vibebox/` directory for instance data.
106138
107139**Configuration (`vibebox.toml`)**
108140
@@ -153,7 +185,7 @@ vibebox explain # show mounts and network info
153185- Default SSH user: `vibecoder`
154186- Hostname: `vibebox`
155187- Base image provisioning installs: build tools, `git`, `curl`, `ripgrep`, `openssh-server`, and `sudo`.
156−- On first login, Vibebox installs `mise` and configures tools like `uv`, `node`, `@openai/codex`, and
188+- On first login, VibeBox installs `mise` and configures tools like `uv`, `node`, `@openai/codex`, and
157189 `@anthropic-ai/claude-code` (best-effort).
158190- Shell aliases: `:help` and `:exit`.
159191
@@ -168,27 +200,24 @@ vibebox explain # show mounts and network info
168200If you're interested in contributing to VibeBox, please read our [contributing docs](CONTRIBUTING.md) before
169201submitting a pull request.
170202
171−### Using VibeBox
172−
173−Feel free to use
174−
175203### FAQ
176204
177−#### How is this different from other Sandboxes?
205+#### How is this different from other sandboxes?
178206
179−Vibebox is built for fast, repeatable local sandboxes with minimal ceremony. What’s different here:
207+VibeBox is built for fast, repeatable local sandboxes with minimal ceremony. What’s different here:
180208
181−- Warm startup is typically under **6 seconds** on my M3, so you can jump back in quickly.
209+- Warm re-entry is typically **<5s** on my M3 (varies by machine/cache), so you can jump back in quickly.
182210- One simple command — `vibebox` — drops you into the sandbox from your project.
183211- Configuration lives in `vibebox.toml`, where you can set CPU, RAM, disk size, and mounts.
212+- Sessions are first-class: reuse, multiple terminals, cleanup.
184213
185−### Special Thank
214+### Special thanks
186215
187216[vibe](https://github.com/lynaghk/vibe) by lynaghk.
188217
189−And amazing Rust community, without your rich crates and fantastic toolchain like [crates.io](https://crates.io), this
190−wouldn't be possible!
218+And the amazing Rust community — without the ecosystem and toolchain like [crates.io](https://crates.io), this wouldn't
219+be possible!
191220
192221---
193222
194−**Follow me on X** [X.com](https://x.com/robcholz)
223+**Follow me on X** [x.com/robcholz](https://x.com/robcholz)
README.zh.md+51−17
@@ -5,7 +5,7 @@
55 </picture>
66 </a>
77</p>
8−<p align="center">超高速、开源的 AI 沙盒。</p>
8+<p align="center">用于安全运行 coding agents 的超高速开源沙盒。</p>
99
1010<p align="center">
1111 <a href="https://crates.io/crates/vibebox">
@@ -24,8 +24,34 @@
2424 <a href="README.md">English</a>
2525</p>
2626
27−VibeBox 是一个轻量、启动极快的沙盒环境,让 AI Agent 可以安全地直接跑命令、改文件、执行代码,不会不停弹“要不要允许”的提示。它基于
28−Apple 的 Virtualization Framework 做到彻底隔离,所以无论 Agent 在里面怎么折腾,你的真实系统都不会被影响;同时做到了低内存和磁盘占用。
27+**VibeBox 是一个按项目划分的 micro-VM 沙盒,用于在 macOS 上运行 coding agents(基于 Apple Virtualization Framework)。**
28+它面向 *日常使用* 工作流优化:快速热启动、显式挂载、可复用会话。
29+
30+**适合谁:** 在 macOS 上使用 coding agents,并且既想要真实隔离又不想牺牲日常效率的人。
31+
32+**快速事实:** 在我的 M3 上,热启动通常 **<5s**(因机器/缓存而异);首次运行会下载并初始化 Debian 基础镜像(受网络影响)。
33+
34+**安全模型:** Linux 来宾 VM + `vibebox.toml` 显式挂载白名单(默认仅项目目录,其它均需显式允许)。
35+
36+- **几秒进入/附加:** `vibebox` 直接进入当前仓库的可复用沙盒
37+- **默认按项目范围:** 显式挂载 + 改动限制在仓库内(repo 优先,其他需 allowlist)
38+- **会话化:** 多实例 + 会话管理(复用、多终端、清理)
39+
40+### 快速演示
41+
42+```bash
43+# 在任意仓库内
44+cd my-project
45+vibebox
46+```
47+
48+你大致会看到:
49+
50+```text
51+vibebox: starting (session: my-project)
52+vibebox: attaching...
53+vibecoder@vibebox:~/my-project$
54+```
2955
3056[![VibeBox Terminal UI](docs/screenshot.png)](https://vibebox.robcholz.com)
3157
@@ -33,22 +59,33 @@ Apple 的 Virtualization Framework 做到彻底隔离,所以无论 Agent 在
3359
3460### 我为什么做 VibeBox
3561
36−我平时经常用像 Codex 和 CC 这样的
37−agent,但一直不太敢让它们直接在我的宿主机上跑。把权限收紧一点,就会被各种“你确定吗?”的确认弹窗不停打断;放松一点,又担心它哪天误操作,碰到不该碰的文件,或者跑了我没打算执行的命令。
62+我每天都在用 coding agents,也希望它们有一个真实的 shell,但不想把宿主机直接交出去。
63+权限收紧会被不停的确认打断;权限放开又担心误删文件、触及密钥,或者跑出仓库边界。
64+
65+VibeBox 是中间方案:按项目隔离、硬 VM 边界、快速回到工作状态、显式挂载。它适合把 agent 当成日常工具,而不是把安全变成负担。
66+
67+### 为什么是 micro-VM(而不是容器)?
3868
39−我想要的是一种体验:像给 agent 一个真实 shell 一样顺滑,但同时又有一道硬隔离的安全边界。于是我做了 VibeBox:一个按项目划分的
40−micro-VM 沙箱,启动很快,改动被限制在仓库范围内,让我可以更高频地迭代,而不用一直盯着权限确认。
69+容器很好用。VibeBox 并不是用来替代 Docker/devcontainers 去构建服务。
70+
71+我更想要的是在 macOS 上适合 agent 的 VM 默认形态:
72+
73+- **默认是 guest-kernel 隔离边界:** 让 agent 跑任意命令时,“安全模式”是 Linux 来宾而不是宿主机。
74+- **会话是第一等公民:** 按项目附加/复用,多终端进入同一沙盒,可靠清理,避免孤儿环境。
75+- **显式挂载白名单作为主要 UX:** 默认仅项目目录,其它都需显式允许。
76+- **最少的每项目配置:** 你可以用 compose/devcontainers 实现一部分,但我想要的是一个命令,在不同仓库间直接工作,不必维护容器配置来获得基础“安全
77+ shell”体验。
4178
4279### 对比
4380
4481下面是我为什么没有直接用现成方案的原因:
4582
46−- **vibe**:非常方便,但对我来说太“极简”了。它缺少一些基础配置能力,也没法提供我工作流里需要的多开和 session 管理。
83+- **vibe**:非常方便,“零配置、直接用”做得很好。但 VibeBox 走的是另一条路:按项目配置 + 会话 + 多实例生命周期。
4784- **QEMU**:很强大,但配置面太大了。日常当沙箱用,它不像是“进到 repo 就能用”,更像是你得先把它当成一个项目来折腾。
48−- **Docker / devcontainers**:生态很成熟,但日常使用对我来说偏重。
85+- **Docker / devcontainers / devpods**:生态很成熟。我的痛点不在启动时间,而是日常保持
86+ safe-by-default(挂载白名单、密钥暴露、附加/复用、清理)的开销,不想为基础 workflow 在每个项目维护容器配置。
4987
50−这些就促使我做了 **VibeBox**:我想要一个按项目隔离的沙箱,进入速度快(直接用 `vibebox`),支持真正可用的配置和
51−sessions,同时还保留明确的硬隔离边界。
88+这就是我做 **VibeBox** 的原因:我想要一个按项目隔离的沙箱,进入快(直接 `vibebox`),支持真实配置 + 会话,同时保持硬隔离边界。
5289
5390### 安装
5491
@@ -149,19 +186,16 @@ vibebox explain # 显示挂载与网络信息
149186
150187如果你想参与贡献 VibeBox,请先阅读 [贡献指南](CONTRIBUTING.md),再提交 Pull Request。
151188
152−### 使用 VibeBox
153−
154−欢迎使用
155−
156189### FAQ
157190
158191#### 它和其它 Sandboxes 有什么不同?
159192
160−Vibebox 追求的是:本地、可复现、启动快、流程简单。主要差异点:
193+VibeBox 追求的是:本地、可复现、启动快、流程简单。主要差异点:
161194
162−- 在我的 M3 上,热启动通常 **6 秒以内**,可以非常快地回到工作状态。
195+- 在我的 M3 上,热启动通常 **<5s**,可以非常快地回到工作状态。
163196- 一个命令——`vibebox`——直接把你带进沙盒(从你的项目目录启动)。
164197- 配置集中在 `vibebox.toml`,CPU / 内存 / 磁盘大小 / 挂载都能一眼看懂、随手改。
198+- 会话是第一等公民:复用、多终端、清理。
165199
166200### 特别鸣谢
167201