Add Windows sandbox to README features#308
Merged
Merged
Conversation
Replaces the OpenClaw card in the feature grid with a Windows sandbox card (OpenClaw remains in the Examples > Advanced table) and adds a "## Windows sandbox" section after Quickstart with a Python usage snippet, the image-build CLI, and a link to the full guide. Scope matches what shipped in #302-#305: SSH + PowerShell via vm.run(), upload_file(), env vars, and per-VM overlay. Linux host only; no desktop/RDP claim. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
📝 WalkthroughWalkthroughREADME feature grid replaces the OpenClaw card with a Windows sandbox card and a new quickstart section shows how to run Windows 11 guests with Python and CLI examples, plus platform notes (Linux host with KVM required). ChangesWindows Sandbox Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
GitHub's image proxy didn't render the cdn.simpleicons.org URL (no .svg extension in the path). Switch to the same Windows logo via Iconify's simple-icons collection, which uses the .svg URL pattern the other seven icons already use. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
147-147: ⚡ Quick winUse plain-English terms before jargon in the section opener.
Right now the opener uses “CLI” and “baseline image” without immediate explanation. For beginners, spell those out in simple words first, then introduce the terms.
Suggested rewrite
-SmolVM can boot a Windows 11 guest as well as Linux. Hand it a Windows image and you get the same Python and CLI you use for Linux — run PowerShell, upload files, set environment variables, and run many sandboxes in parallel from one baseline image. +SmolVM can boot a Windows 11 guest as well as Linux. Give it a Windows disk image, and you can use the same Python API and command-line commands (CLI) as Linux to run PowerShell, upload files, set environment variables, and start many sandboxes from one reusable base image.As per coding guidelines, "If you must use a technical term, explain it immediately in simple language."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 147, Rewrite the opener sentence "SmolVM can boot a Windows 11 guest as well as Linux..." to put plain-English terms before jargon: spell out "command-line interface (CLI)" as "command-line interface (CLI)" and explain "baseline image" as "a common starting virtual machine image (baseline image)"; keep the rest of the sentence (PowerShell, uploading files, setting environment variables, running many sandboxes in parallel) but replace instances of "CLI" and "baseline image" with those expanded phrases so beginners see simple language first and the jargon in parentheses; update the exact sentence fragment that contains "CLI" and "baseline image" accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@README.md`:
- Line 147: Rewrite the opener sentence "SmolVM can boot a Windows 11 guest as
well as Linux..." to put plain-English terms before jargon: spell out
"command-line interface (CLI)" as "command-line interface (CLI)" and explain
"baseline image" as "a common starting virtual machine image (baseline image)";
keep the rest of the sentence (PowerShell, uploading files, setting environment
variables, running many sandboxes in parallel) but replace instances of "CLI"
and "baseline image" with those expanded phrases so beginners see simple
language first and the jargon in parentheses; update the exact sentence fragment
that contains "CLI" and "baseline image" accordingly.
Switch the Windows card icon to a framed (rounded-square) Windows mark and serve it from docs/assets/icons/windows.svg instead of a remote CDN. Recolored to #6e7681 to match the other feature icons. Source: simpleicon.com Windows icon (IcoMoon-generated, fill changed from #000000 to #6e7681). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Actionable comments posted: 0 |
Replace the simpleicon.com-derived framed icon (license unclear) with a bare four-pane Windows mark redrawn in a 24x24 viewBox from FontAwesome 5.15.4's brand path. CC BY 4.0 attribution kept as an SVG comment per the license. Visually consistent with the other seven cards (bare mark, no frame) and self-hosted so the README icon does not depend on a third-party CDN. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
vm.run() auto-waits for SSH internally (facade.py:1318), so the explicit wait_for_ssh() call before it is redundant. Removing it keeps the Windows snippet symmetric with the Linux quickstart example above, which also relies on the implicit wait inside run(). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
## Examples > Advanced.## Windows sandboxsection right after Quickstart with a PythonSmolVM(os="windows", ...)snippet and thesmolvm windows build-imageCLI.Scope matches what landed in #302–#305: SSH + PowerShell via
vm.run(),upload_file(), env vars, and per-VM overlay. Linux host only. No desktop/RDP claim — if that ships later, the card copy can broaden.Test plan
#6e7681color).## Windows sandbox.docs/deep-dive/windows-guest-qemu.md(os="windows",ssh_user="smolvm",ssh_password="smolvm").smolvm windows build-imageinvocation againstsmolvm windows build-image --help.🤖 Generated with Claude Code
Summary by CodeRabbit