-
Notifications
You must be signed in to change notification settings - Fork 7.2k
docs: add Windows support to install docs and justfile #8730
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
All contributors have signed the CLA ✍️ ✅ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b4966c9a94
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
justfile
Outdated
| codex *args: | ||
| cargo run --bin codex -- "$@" | ||
| cargo run --bin codex -- "{{args}}" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Preserve variadic args when invoking cargo helpers
Wrapping {{args}} in quotes collapses every argument into a single argv entry. After this change, running just codex --foo bar executes cargo run … -- "--foo bar", so the binary sees one combined argument instead of the intended --foo and bar. This breaks forwarding of multiple arguments (similarly in the other *args recipes such as exec, file-search, app-server-test-client, fix, and mcp-server-run).
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds Windows 11 support by updating the installation documentation and modifying the justfile for Windows compatibility. The changes address issue #8729 which requested that Windows be listed as a supported OS since the codebase already works on Windows (as evidenced by CI testing on Windows runners).
Key changes:
- Updated system requirements table to list Windows 11 as directly supported (removing the "via WSL2" qualifier)
- Modified justfile to work on Windows by replacing bash-style
$@with just's{{args}}syntax, removingset positional-arguments, and adding PowerShell as the Windows shell
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/install.md | Removed WSL2 requirement qualifier from Windows 11 in the OS compatibility table |
| justfile | Updated for Windows compatibility: added PowerShell shell configuration, replaced positional argument syntax from $@ to {{args}} in all recipes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
justfile
Outdated
| cargo clippy --fix --all-features --tests --allow-dirty "$@" | ||
| cargo clippy --fix --all-features --tests --allow-dirty "{{args}}" | ||
|
|
||
| clippy: |
Copilot
AI
Jan 5, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The clippy recipe is using {{args}} but does not declare *args in its parameter list. This will cause an error when the recipe is invoked. The recipe signature should be changed to clippy *args: to match the other recipes that accept arguments, or the {{args}} should be removed from the command if arguments are not intended to be supported.
| clippy: | |
| clippy *args: |
docs/install.md
Outdated
| | Requirement | Details | | ||
| | --------------------------- | --------------------------------------------------------------- | | ||
| | Operating systems | macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 **via WSL2** | | ||
| | Operating systems | macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 | |
Copilot
AI
Jan 5, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing the "via WSL2" qualifier makes it appear that native Windows 11 is fully supported, but the installation instructions below (lines 23-24, 57) contain bash-specific commands that won't work on native Windows PowerShell. Either the documentation should be updated to include Windows-specific installation instructions, or the change should specify that while the codebase itself supports Windows, the setup instructions assume a Unix-like environment. Consider adding a note about Windows-specific setup or keeping the WSL2 qualifier until Windows-native installation instructions are added.
| | Operating systems | macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 | | |
| | Operating systems | macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 (via WSL2 or another Unix-like environment) | |
|
I have read the CLA Document and I hereby sign the CLA |
|
Windows (without WSL) is not yet fully supported. We consider it in "experimental mode". We'll move it into "fully supported" mode once our new sandboxing mechanism is ready. Please see the code review comments about your proposed changes to the justfile. |
Fixes #8729. Added Windows 11 to supported OS list in install.md and updated justfile for Windows compatibility.