git.iko.soy/vibebox
on main help sign in
doc: added readme and contributing.md
commita1056ba5cb0b89bf3573ef7ee626227fac701166 authorrobcholz <84130577+robcholz@users.noreply.github.com> dateSun 8 Feb 2026, 01:53 (8 months ago) parentad8fb13
5 files changed+126
compare with main
unifiedsplit
CONTRIBUTING.md+44 README.md+82 README.zh.md docs/banner.png docs/screenshot.png
CONTRIBUTING.mdnew file+44
@@ -0,0 +1,44 @@
1+# Contributing to Vibebox
2+
3+Thanks for your interest in contributing! This guide keeps PRs small, reviewable, and consistent with the project’s
4+development workflow.
5+
6+**Prerequisites**
7+
8+- macOS on Apple Silicon (required for the virtualization backend)
9+- Rust `1.91.1` or newer (see `Cargo.toml`)
10+
11+**Getting Started**
12+
13+1. Fork the repo and create a feature branch.
14+2. Build once to validate your toolchain:
15+
16+```bash
17+cargo build --locked
18+```
19+
20+**Development Commands**
21+
22+- Format: `cargo fmt --all -- --check`
23+- Lint: `cargo clippy --all-targets --all-features -- -D warnings`
24+- Test: `cargo test --locked`
25+- Build: `cargo build --locked`
26+
27+**Submitting Changes**
28+
29+- Keep changes focused and scoped to one problem.
30+- Update or add tests when behavior changes.
31+- If you change user-facing behavior, update docs or help text.
32+- Avoid adding heavy dependencies without a clear reason.
33+
34+**Reporting Issues**
35+Please include:
36+
37+- macOS version and hardware (Apple Silicon model)
38+- Vibebox version (`vibebox --version`)
39+- Steps to reproduce
40+- Logs from `.vibebox/cli.log`, `.vibebox/vm_root.log` and `.vibebox/vm_manager.log`
41+
42+**Security**
43+If you believe you’ve found a security issue, please avoid public disclosure. Open a private report via GitHub Security
44+Advisories instead.
README.md+82
@@ -0,0 +1,82 @@
1+<p align="center">
2+ <a href="https://vibebox.robcholz.com">
3+ <picture>
4+ <img src="docs/banner.png" alt="VibeBox logo">
5+ </picture>
6+ </a>
7+</p>
8+<p align="center">The open source AI coding agent.</p>
9+
10+[![Crates.io][crates-badge]][crates-url]
11+[![MIT licensed][mit-badge]][mit-url]
12+[![Build Status][actions-badge]][actions-url]
13+
14+[crates-badge]: https://img.shields.io/crates/v/vibebox.svg
15+
16+[crates-url]: https://crates.io/crates/vibebox
17+
18+[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
19+
20+[mit-url]: https://github.com/robcholz/vibebox/blob/main/LICENSE
21+
22+[actions-badge]: https://github.com/robcholz/vibebox/workflows/CI/badge.svg
23+
24+[actions-url]: https://github.com/robcholz/vibebox/actions?query=workflow%3ACI+branch%3Amain
25+
26+<p align="center">
27+ <a href="README.md">English</a> |
28+ <a href="README.zh.md">简体中文</a> |
29+</p>
30+
31+[![OpenCode Terminal UI](docs/screenshot.png)](https://vibebox.robcholz.com)
32+
33+---
34+
35+### Installation
36+
37+```bash
38+# YOLO
39+curl -fsSL https://raw.githubusercontent.com/robcholz/vibebox/main/install | bash
40+
41+# Package managers
42+cargo install vibebox
43+```
44+
45+> [!TIP]
46+> We truly recommend you to use `YOLO`.
47+
48+todo
49+
50+### Documentation
51+
52+todo
53+
54+### Contributing
55+
56+If you're interested in contributing to VibeBox, please read our [contributing docs](CONTRIBUTING.md) before
57+submitting a pull request.
58+
59+### Using VibeBox
60+
61+Feel free to use, but remember to promote VibeBox as well!
62+
63+### FAQ
64+
65+#### How is this different from other Sandboxes?
66+
67+Vibebox is built for fast, repeatable local sandboxes with minimal ceremony. What’s different here:
68+
69+- Warm startup is typically under **6 seconds** on my M3, so you can jump back in quickly.
70+- One simple command — `vibebox` — drops you into the sandbox from your project.
71+- Configuration lives in `vibebox.toml`, where you can set CPU, RAM, disk size, and mounts.
72+
73+### Special Thank
74+
75+[vibe](https://github.com/lynaghk/vibe) by lynaghk.
76+
77+And amazing Rust community, without your rich crates and fantastic toolchain like [crates.io](https://crates.io), this
78+wouldn't be possible!
79+
80+---
81+
82+**Follow me on X** [X.com](https://x.com/robcholz)
README.zh.mdnew file

No changes to the content.

docs/banner.pngnew file

Binary file not shown.

docs/screenshot.pngnew file

Binary file not shown.