docs(readme): rewrite around container runtime positioning#351
Conversation
There was a problem hiding this comment.
Pull request overview
This PR rewrites the top-level README to reposition ArcBox primarily as a fast, open-source Docker/OrbStack alternative for macOS, with additional sections covering Kubernetes, sandboxes (microVMs), and longer-term “ArcBox Platform” direction.
Changes:
- Reworked “Why ArcBox” messaging and project positioning around macOS container runtime + open-source framing.
- Reorganized the flow (Quick start moved up; expanded Containers/Kubernetes/Sandboxes/Machines sections).
- Updated badges/links and added/trimmed sections (built-from-scratch details, roadmap, and updated requirements/contributing text).
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes — a docs-only rewrite of README.md that repositions ArcBox as a fast, open-source container runtime for macOS (Docker Desktop / OrbStack alternative) rather than an AI-agent sandbox engine. I verified every factual and command claim against the codebase.
- CLI rename
arcbox→abctl— matches the real binary;app/arcbox-cli/Cargo.tomldeclares[[bin]] name = "abctl"and thearcboxbin is now a placeholder. - Reorder + new sections — quick start moved above containers; adds
Sandboxes,Bring your own machine(ArcBox Platform),Built from scratch, and an OrbStack comparison table. - All example commands exist —
daemon start,docker enable/setup,doctor,k8s start/kubeconfig,migrate from docker-desktop/orbstack,sandbox create/run/checkpoint/restore,machine create/start/listall map to real subcommands. - Badge/link updates —
LICENSE-MITbadge target exists,rust-1.96+matches the workspacerust-version, and theget.arcbox.devinstall URL matchesscripts/install.sh.
A few accuracy points worth calling out, all of which check out:
- The "Shell and SSH access into a running machine is coming" claim is correct — the machine
execRPC currently returnsStatus::unimplementedinapp/arcbox-api/src/grpc/machine.rs, so theabctl machine ssh/execCLI commands don't function yet. - The amd64/FEX claim ("x86-64 is translated inside the guest by FEX, with nothing to configure") is backed by
RuntimeTranslator::Fexinapp/arcbox-docker/src/routing.rsand the bundled FEX64 runtime in the boot assets.
Nothing blocking.
Claude Opus | 𝕏
Greptile SummaryThis PR rewrites the README around ArcBox's container-runtime positioning. The main changes are:
Confidence Score: 4/5The README should be corrected before merging because it documents unsupported user workflows as ready today.
README.md Important Files Changed
Reviews (1): Last reviewed commit: "docs(readme): trim Why ArcBox and de-dup..." | Re-trigger Greptile |

Summary
Test plan