| Name | cargo-xwin JSON |
| Version |
0.20.2
JSON |
| download |
| home_page | None |
| Summary | Cross compile Cargo project to Windows MSVC target with ease |
| upload_time | 2025-11-04 11:21:28 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT |
| keywords |
windows
cargo
msvc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# cargo-xwin
_formerly cargo-xwinbuild_
[](https://github.com/rust-cross/cargo-xwin/actions?query=workflow%3ACI)
[](https://crates.io/crates/cargo-xwin)
[](https://docs.rs/cargo-xwin/)
[](https://pypi.org/project/cargo-xwin)
[](https://hub.docker.com/r/messense/cargo-xwin/)
> 🚀 Help me to become a full-time open-source developer by [sponsoring me on GitHub](https://github.com/sponsors/messense)
Cross compile Cargo project to Windows msvc target with ease using [xwin](https://github.com/Jake-Shadle/xwin) or [windows-msvc-sysroot](https://github.com/trcrsired/windows-msvc-sysroot).
**By using this software you are consented to accept the license at [https://go.microsoft.com/fwlink/?LinkId=2086102](https://go.microsoft.com/fwlink/?LinkId=2086102)**
## Prerequisite
1. Install [clang](https://clang.llvm.org/) (On macOS run `brew install llvm` and you're good to go).
2. For assembly dependencies, install `llvm-tools` component via `rustup component add llvm-tools` or install [llvm](https://llvm.org).
A full LLVM installation is recommended to avoid possible issues.
## Installation
```bash
cargo install --locked cargo-xwin
```
You can also install it using pip:
```bash
pip install cargo-xwin
```
We also provide a [Docker image](https://hub.docker.com/r/messense/cargo-xwin) which has wine pre-installed in addition to cargo-xwin and Rust,
for example to build for x86_64 Windows:
```bash
docker run --rm -it -v $(pwd):/io -w /io messense/cargo-xwin \
cargo xwin build --release --target x86_64-pc-windows-msvc
```
## Usage
1. Install Rust Windows msvc target via rustup, for example, `rustup target add x86_64-pc-windows-msvc`
2. Run `cargo xwin build`, for example, `cargo xwin build --target x86_64-pc-windows-msvc`
### Run tests with wine
With wine installed, you can run tests with the `cargo xwin test` command,
for example, `cargo xwin test --target x86_64-pc-windows-msvc`
### Running Windows executables in WSL (without wine)
If you want to run Windows executables directly in WSL (without using wine), you can set the runner environment variable as follows:
```bash
CARGO_TARGET_X86_64_PC_WINDOWS_MSVC_RUNNER="/usr/bin/env" cargo xwin run --target x86_64-pc-windows-msvc
```
### Customization
The Microsoft CRT and Windows SDK can be customized using the following environment variables or CLI options.
| Environment Variable | CLI option | Description |
| ---------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `XWIN_CROSS_COMPILER` | `--cross-compiler` | The cross compiler to use, defaults to `clang-cl`, possible values: `clang-cl`, `clang` |
| `XWIN_ARCH` | `--xwin-arch` | The architectures to include, defaults to `x86_64,aarch64`, possible values: x86, x86_64, aarch, aarch64 |
| `XWIN_VARIANT` | `--xwin-variant` | The variants to include, defaults to `desktop`, possible values: desktop, onecore, spectre |
| `XWIN_VERSION` | `--xwin-version` | The version to retrieve, defaults to 17, can either be a major version of 15, 16, or 17, or a `<major>.<minor>` version |
| `XWIN_SDK_VERSION` | `--xwin-sdk-version` | The SDK version to retrieve, defaults to the latest version |
| `XWIN_CRT_VERSION` | `--xwin-crt-version` | The CRT version to retrieve, defaults to the latest version |
| `XWIN_INCLUDE_ATL` | `--xwin-include-atl` | Whether to include the Active Template Library (ATL) in the installation |
| `XWIN_CACHE_DIR` | `--xwin-cache-dir` | xwin cache directory to put CRT and SDK files |
| `XWIN_INCLUDE_DEBUG_LIBS` | `--xwin-include-debug-libs` | Whether or not to include debug libs in installation (default false). |
| `XWIN_INCLUDE_DEBUG_SYMBOLS` | `--xwin-include-debug-symbols` | Whether or not to include debug symbols (PDBs) in installation (default false). |
### CMake Support
Some Rust crates use the [cmake](https://github.com/alexcrichton/cmake-rs) crate to build C/C++ dependencies,
cargo-xwin will generate a [CMake toolchain](https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html) file
automatically to make cross compilation work out of the box.
**[ninja](https://ninja-build.org/) is required** to enable CMake support.
## License
This work is released under the MIT license. A copy of the license is provided
in the [LICENSE](./LICENSE) file.
Raw data
{
"_id": null,
"home_page": null,
"name": "cargo-xwin",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "windows, cargo, msvc",
"author": null,
"author_email": null,
"download_url": null,
"platform": null,
"description": "# cargo-xwin\n\n_formerly cargo-xwinbuild_\n\n[](https://github.com/rust-cross/cargo-xwin/actions?query=workflow%3ACI)\n[](https://crates.io/crates/cargo-xwin)\n[](https://docs.rs/cargo-xwin/)\n[](https://pypi.org/project/cargo-xwin)\n[](https://hub.docker.com/r/messense/cargo-xwin/)\n\n> \ud83d\ude80 Help me to become a full-time open-source developer by [sponsoring me on GitHub](https://github.com/sponsors/messense)\n\nCross compile Cargo project to Windows msvc target with ease using [xwin](https://github.com/Jake-Shadle/xwin) or [windows-msvc-sysroot](https://github.com/trcrsired/windows-msvc-sysroot).\n\n**By using this software you are consented to accept the license at [https://go.microsoft.com/fwlink/?LinkId=2086102](https://go.microsoft.com/fwlink/?LinkId=2086102)**\n\n## Prerequisite\n\n1. Install [clang](https://clang.llvm.org/) (On macOS run `brew install llvm` and you're good to go).\n2. For assembly dependencies, install `llvm-tools` component via `rustup component add llvm-tools` or install [llvm](https://llvm.org).\n\nA full LLVM installation is recommended to avoid possible issues.\n\n## Installation\n\n```bash\ncargo install --locked cargo-xwin\n```\n\nYou can also install it using pip:\n\n```bash\npip install cargo-xwin\n```\n\nWe also provide a [Docker image](https://hub.docker.com/r/messense/cargo-xwin) which has wine pre-installed in addition to cargo-xwin and Rust,\nfor example to build for x86_64 Windows:\n\n```bash\ndocker run --rm -it -v $(pwd):/io -w /io messense/cargo-xwin \\\n cargo xwin build --release --target x86_64-pc-windows-msvc\n```\n\n## Usage\n\n1. Install Rust Windows msvc target via rustup, for example, `rustup target add x86_64-pc-windows-msvc`\n2. Run `cargo xwin build`, for example, `cargo xwin build --target x86_64-pc-windows-msvc`\n\n### Run tests with wine\n\nWith wine installed, you can run tests with the `cargo xwin test` command,\nfor example, `cargo xwin test --target x86_64-pc-windows-msvc`\n\n### Running Windows executables in WSL (without wine)\n\nIf you want to run Windows executables directly in WSL (without using wine), you can set the runner environment variable as follows:\n\n```bash\nCARGO_TARGET_X86_64_PC_WINDOWS_MSVC_RUNNER=\"/usr/bin/env\" cargo xwin run --target x86_64-pc-windows-msvc\n```\n\n### Customization\n\nThe Microsoft CRT and Windows SDK can be customized using the following environment variables or CLI options.\n\n| Environment Variable | CLI option | Description |\n| ---------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------ |\n| `XWIN_CROSS_COMPILER` | `--cross-compiler` | The cross compiler to use, defaults to `clang-cl`, possible values: `clang-cl`, `clang` |\n| `XWIN_ARCH` | `--xwin-arch` | The architectures to include, defaults to `x86_64,aarch64`, possible values: x86, x86_64, aarch, aarch64 |\n| `XWIN_VARIANT` | `--xwin-variant` | The variants to include, defaults to `desktop`, possible values: desktop, onecore, spectre |\n| `XWIN_VERSION` | `--xwin-version` | The version to retrieve, defaults to 17, can either be a major version of 15, 16, or 17, or a `<major>.<minor>` version |\n| `XWIN_SDK_VERSION` | `--xwin-sdk-version` | The SDK version to retrieve, defaults to the latest version |\n| `XWIN_CRT_VERSION` | `--xwin-crt-version` | The CRT version to retrieve, defaults to the latest version |\n| `XWIN_INCLUDE_ATL` | `--xwin-include-atl` | Whether to include the Active Template Library (ATL) in the installation |\n| `XWIN_CACHE_DIR` | `--xwin-cache-dir` | xwin cache directory to put CRT and SDK files |\n| `XWIN_INCLUDE_DEBUG_LIBS` | `--xwin-include-debug-libs` | Whether or not to include debug libs in installation (default false). |\n| `XWIN_INCLUDE_DEBUG_SYMBOLS` | `--xwin-include-debug-symbols` | Whether or not to include debug symbols (PDBs) in installation (default false). |\n\n### CMake Support\n\nSome Rust crates use the [cmake](https://github.com/alexcrichton/cmake-rs) crate to build C/C++ dependencies,\ncargo-xwin will generate a [CMake toolchain](https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html) file\nautomatically to make cross compilation work out of the box.\n\n**[ninja](https://ninja-build.org/) is required** to enable CMake support.\n\n## License\n\nThis work is released under the MIT license. A copy of the license is provided\nin the [LICENSE](./LICENSE) file.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Cross compile Cargo project to Windows MSVC target with ease",
"version": "0.20.2",
"project_urls": {
"Source Code": "https://github.com/rust-cross/cargo-xwin"
},
"split_keywords": [
"windows",
" cargo",
" msvc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "56cf090f775f52d68c96e58992a415fc5e2231b098a2f266cf170aefca3f194f",
"md5": "1cb83ebbf084e7670af584fcb578cfd1",
"sha256": "8542a65b1b2f9f595962913769aaf7da727588f91526472033abf29e0776bd9b"
},
"downloads": -1,
"filename": "cargo_xwin-0.20.2-py3-none-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "1cb83ebbf084e7670af584fcb578cfd1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6999726,
"upload_time": "2025-11-04T11:21:28",
"upload_time_iso_8601": "2025-11-04T11:21:28.173780Z",
"url": "https://files.pythonhosted.org/packages/56/cf/090f775f52d68c96e58992a415fc5e2231b098a2f266cf170aefca3f194f/cargo_xwin-0.20.2-py3-none-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b8ea997277b3deba2db5b46c1b225c629cd1006a78f6d0897eb194da0934d684",
"md5": "839fb0361003efba91a50c96ec05d53f",
"sha256": "5e875d240af44bebb095ed28147161815b7324476c258355376fc42175e386c4"
},
"downloads": -1,
"filename": "cargo_xwin-0.20.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "839fb0361003efba91a50c96ec05d53f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3606427,
"upload_time": "2025-11-04T11:21:30",
"upload_time_iso_8601": "2025-11-04T11:21:30.657531Z",
"url": "https://files.pythonhosted.org/packages/b8/ea/997277b3deba2db5b46c1b225c629cd1006a78f6d0897eb194da0934d684/cargo_xwin-0.20.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-04 11:21:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rust-cross",
"github_project": "cargo-xwin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cargo-xwin"
}
