Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Installation
# YOLO
|
# Package managers
# Or manually (bad)
[!TIP] We truly recommend you to use
YOLOto install.
Requirements
- macOS on Apple Silicon (Vibebox uses Apple's virtualization APIs).
First Run
The first vibebox run downloads a Debian base image and provisions it. After that, per-project instances reuse the
cached base image for much faster startups.
Documentation
Quick Start
On first run, Vibebox creates vibebox.toml in your project (if missing) and a .vibebox/ directory for instance data.
Configuration (vibebox.toml)
vibebox.toml lives in your project root by default. You can override it with vibebox -c path/to/vibebox.toml or the
VIBEBOX_CONFIG_PATH env var, but the path must stay inside the project directory.
Default config (auto-created when missing):
[]
= 2
= 2048
= 5
= [
"~/.codex:~/.codex:read-write",
"~/.claude:~/.claude:read-write",
]
[]
= 20000
disk_gb is only applied when the instance disk is first created. If you change it later, run vibebox reset to
recreate the disk.
Mounts
- Your project is mounted read-write at
~/<project-name>, and the shell starts there. - If a
.gitdirectory exists, it is masked with a tmpfs mount inside the VM to discourage accidental edits from the guest. - Extra mounts come from
box.mountswith the formathost:guest[:read-only|read-write]. - Host paths support
~expansion. Relative guest paths are treated as/root/<path>. - Guest paths that use
~are linked into/home/<ssh-user>for convenience. Runvibebox explainto see the resolved host/guest mappings.
CLI Commands
Inside the VM
- Default SSH user:
vibecoder - Hostname:
vibebox - Base image provisioning installs: build tools,
git,curl,ripgrep,openssh-server, andsudo. - On first login, Vibebox installs
miseand configures tools likeuv,node,@openai/codex, and@anthropic-ai/claude-code(best-effort). - Shell aliases:
:helpand:exit.
State & Cache
- Project state lives in
.vibebox/(instance disk, SSH keys, logs, manager socket/pid).vibebox resetremoves it. - Global cache lives in
~/.cache/vibebox(base image + shared guest cache).vibebox purge-cacheclears it. - Session index lives in
~/.vibebox/sessionsand is shown byvibebox list.
Contributing
If you're interested in contributing to VibeBox, please read our contributing docs before submitting a pull request.
Using VibeBox
Feel free to use, but remember to promote VibeBox as well!
FAQ
How is this different from other Sandboxes?
Vibebox is built for fast, repeatable local sandboxes with minimal ceremony. What’s different here:
- Warm startup is typically under 6 seconds on my M3, so you can jump back in quickly.
- One simple command —
vibebox— drops you into the sandbox from your project. - Configuration lives in
vibebox.toml, where you can set CPU, RAM, disk size, and mounts.
Special Thank
vibe by lynaghk.
And amazing Rust community, without your rich crates and fantastic toolchain like crates.io, this wouldn't be possible!
Follow me on X X.com
