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

Open
gowthamrdyy wants to merge 7 commits into
base: main
Choose a base branch
from
+14 −14
Open

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

Show file tree
Hide file tree
Changes from all commits
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
10 changes: 5 additions & 5 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

### System requirements

| Requirement | Details |
| --------------------------- | --------------------------------------------------------------- |
| Operating systems | macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 **via WSL2** |
| Git (optional, recommended) | 2.23+ for built-in PR helpers |
| RAM | 4-GB minimum (8-GB recommended) |
| Requirement | Details |
| --------------------------- | ----------------------------------------------------------------- |
| Operating systems | macOS 12+, Ubuntu 20.04+/Debian 10+, or Windows 11 (Experimental) |
| Git (optional, recommended) | 2.23+ for built-in PR helpers |
| RAM | 4-GB minimum (8-GB recommended) |

### DotSlash

Expand Down
18 changes: 9 additions & 9 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
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}}

# `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:
cargo clippy --all-features --tests "$@"
clippy *args:
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}}