| Name | cargo-xwin JSON |
| Version |
0.18.3
JSON |
| download |
| home_page | None |
| Summary | Cross compile Cargo project to Windows MSVC target with ease |
| upload_time | 2024-12-24 15:09:52 |
| 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`
### 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 16, can either be a major version of 15 or 16, or a `<major>.<minor>` version |
| `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### 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 16, can either be a major version of 15 or 16, or a `<major>.<minor>` version |\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.18.3",
"project_urls": {
"Source Code": "https://github.com/rust-cross/cargo-xwin"
},
"split_keywords": [
"windows",
" cargo",
" msvc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "55d26624356d4769657c7e6d5eaa6672abf0efcde3ba87e0bdc815cfec90065f",
"md5": "f3f0a5d2d2228d9eaeca12c0c7748144",
"sha256": "29ce92ab170fb3b22f45ece2d8e0548e2a17415cf8a4271dc5e0a6c59a51cccc"
},
"downloads": -1,
"filename": "cargo_xwin-0.18.3-py3-none-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl",
"has_sig": false,
"md5_digest": "f3f0a5d2d2228d9eaeca12c0c7748144",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8097513,
"upload_time": "2024-12-24T15:09:52",
"upload_time_iso_8601": "2024-12-24T15:09:52.719598Z",
"url": "https://files.pythonhosted.org/packages/55/d2/6624356d4769657c7e6d5eaa6672abf0efcde3ba87e0bdc815cfec90065f/cargo_xwin-0.18.3-py3-none-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "517c6fbd1a65209da1c052602b3372b5181dc3409a00866481c72a87a61d65ec",
"md5": "5fd46e70f29fcb2d4c4f3ef177d2c977",
"sha256": "ea9428e50c09329acb4c8cca8375aa129cdf881c8bac9a73e9e14a2ffcdd414f"
},
"downloads": -1,
"filename": "cargo_xwin-0.18.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "5fd46e70f29fcb2d4c4f3ef177d2c977",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4328550,
"upload_time": "2024-12-24T15:09:55",
"upload_time_iso_8601": "2024-12-24T15:09:55.169631Z",
"url": "https://files.pythonhosted.org/packages/51/7c/6fbd1a65209da1c052602b3372b5181dc3409a00866481c72a87a61d65ec/cargo_xwin-0.18.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "070d220a7a8e18db2de517354afaa649b06925b2d69880ec694e448f1ca23577",
"md5": "88422f0f5c3034a33a66ced876c079c8",
"sha256": "d4aae7a158ce3f4249d30a8fb74025889315d51ca15f2f51857bbcb6d043027b"
},
"downloads": -1,
"filename": "cargo_xwin-0.18.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"has_sig": false,
"md5_digest": "88422f0f5c3034a33a66ced876c079c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4110052,
"upload_time": "2024-12-24T15:09:58",
"upload_time_iso_8601": "2024-12-24T15:09:58.260220Z",
"url": "https://files.pythonhosted.org/packages/07/0d/220a7a8e18db2de517354afaa649b06925b2d69880ec694e448f1ca23577/cargo_xwin-0.18.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5e4ebb102427c7aeac588d623c178e79eae3137643d7e9dc1a5eb06aec874ec2",
"md5": "68964aa45eb33be4531d60a754f2d82e",
"sha256": "7e536627a477f3fcf2dfd791ded7f469669b23b4f99d37922f2e7b88b7a9a8b0"
},
"downloads": -1,
"filename": "cargo_xwin-0.18.3-py3-none-manylinux_2_5_i686.manylinux1_i686.whl",
"has_sig": false,
"md5_digest": "68964aa45eb33be4531d60a754f2d82e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4350895,
"upload_time": "2024-12-24T15:10:01",
"upload_time_iso_8601": "2024-12-24T15:10:01.356613Z",
"url": "https://files.pythonhosted.org/packages/5e/4e/bb102427c7aeac588d623c178e79eae3137643d7e9dc1a5eb06aec874ec2/cargo_xwin-0.18.3-py3-none-manylinux_2_5_i686.manylinux1_i686.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "09ca453b54a1a152a6343f109e93885b20a010b2697759a3a82d4d865fdab2b2",
"md5": "26733c11559a49ba475da557d20ef574",
"sha256": "0f8caffbfedf2e2a7218a493935b2fe30f144d601d242d78a6fe0fe3bbbfd267"
},
"downloads": -1,
"filename": "cargo_xwin-0.18.3-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl",
"has_sig": false,
"md5_digest": "26733c11559a49ba475da557d20ef574",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4579703,
"upload_time": "2024-12-24T15:10:04",
"upload_time_iso_8601": "2024-12-24T15:10:04.855043Z",
"url": "https://files.pythonhosted.org/packages/09/ca/453b54a1a152a6343f109e93885b20a010b2697759a3a82d4d865fdab2b2/cargo_xwin-0.18.3-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ce9e87a9cc190bcaae90c5e4e1a2b7c2c1c53d4886f5463137bfeb0611202013",
"md5": "71e3d9c37368f028bdeaa9e34fab1689",
"sha256": "d1d3899d5b3a97494418becf4593ef8dd4db8219e6018497ba93da2313084b41"
},
"downloads": -1,
"filename": "cargo_xwin-0.18.3-py3-none-win32.whl",
"has_sig": false,
"md5_digest": "71e3d9c37368f028bdeaa9e34fab1689",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3230067,
"upload_time": "2024-12-24T15:10:11",
"upload_time_iso_8601": "2024-12-24T15:10:11.368909Z",
"url": "https://files.pythonhosted.org/packages/ce/9e/87a9cc190bcaae90c5e4e1a2b7c2c1c53d4886f5463137bfeb0611202013/cargo_xwin-0.18.3-py3-none-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4bbae02634c45f7099f9377afb8425bc6be57325700a9687a98e730d8fa0ef7f",
"md5": "7edf5ff15bd61980e9aea8e6458efd52",
"sha256": "9a52caec385da2b78b6bb0c18bb00c7df8f869d3c6b47a1ae285e5dd6157d14a"
},
"downloads": -1,
"filename": "cargo_xwin-0.18.3-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "7edf5ff15bd61980e9aea8e6458efd52",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3699206,
"upload_time": "2024-12-24T15:10:16",
"upload_time_iso_8601": "2024-12-24T15:10:16.651656Z",
"url": "https://files.pythonhosted.org/packages/4b/ba/e02634c45f7099f9377afb8425bc6be57325700a9687a98e730d8fa0ef7f/cargo_xwin-0.18.3-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-24 15:09:52",
"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"
}
