Skip to content

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.

Sign up for GitHub

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

Closed
gowthamrdyy wants to merge 7 commits into from
Closed

docs: add Windows support to install docs and justfile #8730

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b4966c9
docs: add Windows support to install docs and justfile
gowthamrdyy Jan 5, 2026
f4f6bb7
fix(justfile): remove quoting around {{args}} and fix clippy recipe
gowthamrdyy Jan 5, 2026
86c1f01
Merge branch 'main' into main
gowthamrdyy Jan 5, 2026
4bdaff8
Merge branch 'main' into main
gowthamrdyy Jan 5, 2026
2db0ef6
docs: mark Windows support as experimental
gowthamrdyy Jan 5, 2026
b19251a
style: fix formatting in install.md
gowthamrdyy Jan 5, 2026
2eaffd4
Merge branch 'main' into main
gowthamrdyy Jan 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| 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 |
Copy link

Copilot AI Jan 5, 2026

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.

Suggested change
| 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) |

Copilot uses AI. Check for mistakes.
| Git (optional, recommended) | 2.23+ for built-in PR helpers |
| RAM | 4-GB minimum (8-GB recommended) |

Expand Down
16 changes: 8 additions & 8 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
set working-directory := "codex-rs"
set positional-arguments
Copy link
Collaborator

@bolinfest bolinfest Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not convinced it is safe to take this away. See #1169 that added it in the first place.

The PR body explains why {{args}} was not working for us.

set windows-shell := ["powershell.exe", "-NoProfile", "-Command"]

# Display help
help:
Expand All @@ -8,30 +8,30 @@ help:
# `codex`
alias c := codex
codex *args:
cargo run --bin codex -- "$@"
cargo run --bin codex -- "{{args}}"
Copy link
Contributor

@chatgpt-codex-connector chatgpt-codex-connector bot Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge 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 👍 / 👎.


# `codex exec`
exec *args:
cargo run --bin codex -- exec "$@"
cargo run --bin codex -- exec "{{args}}"

# Run the CLI version of the file-search crate.
file-search *args:
cargo run --bin codex-file-search -- "$@"
cargo run --bin codex-file-search -- "{{args}}"

# Build the CLI and run the app-server test client
app-server-test-client *args:
cargo build -p codex-cli
cargo run -p codex-app-server-test-client -- --codex-bin ./target/debug/codex "$@"
cargo run -p codex-app-server-test-client -- --codex-bin ./target/debug/codex "{{args}}"

# format code
fmt:
cargo fmt -- --config imports_granularity=Item

fix *args:
cargo clippy --fix --all-features --tests --allow-dirty "$@"
cargo clippy --fix --all-features --tests --allow-dirty "{{args}}"

clippy:
Copy link

Copilot AI Jan 5, 2026

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.

Suggested change
clippy:
clippy *args:

Copilot uses AI. Check for mistakes.
cargo clippy --all-features --tests "$@"
cargo clippy --all-features --tests "{{args}}"

install:
rustup show active-toolchain
Expand All @@ -46,4 +46,4 @@ test:

# Run the MCP server
mcp-server-run *args:
cargo run -p codex-mcp-server -- "$@"
cargo run -p codex-mcp-server -- "{{args}}"