Traditional Installation

The traditional installation process is required for Swift older than 5.4.2.

Swift has been tested with Visual Studio 2019. You will need to install Visual Studio with the following components. The installer for Swift is available in the Download section. The toolchain on Windows is typically installed to %SystemDrive%\Library\Developer\Toolchains.

The following Visual Studio components are required:

Component Visual Studio ID
MSVC v142 - VS 2019 C++ x64/x86 build tools (Latest) Microsoft.VisualStudio.Component.VC.Tools.x86.x64
Windows 10 SDK (10.0.17763.0)1 Microsoft.VisualStudio.Component.Windows10SDK.17763

The following additional Visual Studio components are recommended:

Component Visual Studio ID
Git for Windows Microsoft.VisualStudio.Component.Git
Python 3 64-bit (3.7.8) Component.CPython.x64

The following additional Visual Studio component is suggested:

Component Visual Studio ID
C++ CMake tools for Windows Microsoft.VisualStudio.Component.VC.CMake.Project

After Visual Studio and the required components are installed:

  1. Download a latest Swift release (5.10.1) or development snapshot installer.

  2. Run the package installer.

Support Files

This is only required for versions older than 5.4.2.

You must run the following commands using x64 Native Tools for VS2019 Command Prompt as administrator. The x64 Native Tools for VS2019 Command Prompt sets up the necessary environment variables to find the system headers. Administrator permission is required to modify the Visual Studio installation.

In order to make the Windows SDK accessible to Swift, it is necessary to deploy a few files into the Windows SDK.

copy /Y %SDKROOT%\usr\share\ucrt.modulemap "%UniversalCRTSdkDir%\Include\%UCRTVersion%\ucrt\module.modulemap"
copy /Y %SDKROOT%\usr\share\visualc.modulemap "%VCToolsInstallDir%\include\module.modulemap"
copy /Y %SDKROOT%\usr\share\visualc.apinotes "%VCToolsInstallDir%\include\visualc.apinotes"
copy /Y %SDKROOT%\usr\share\winsdk.modulemap "%UniversalCRTSdkDir%\Include\%UCRTVersion%\um\module.modulemap"

Because it is installing the files into the Visual Studio image, the files will need to be copied each time Visual Studio is updated.

Repairing after Visual Studio Updates

This is only required for versions older than 5.9.0.

If Visual Studio is updated, you may have to repair the installation. For versions older than 5.4.2, reinstall support files as mentioned above. For newer versions, see Microsoft’s instructions for repairing installed programs.

Code Signing on Windows

The following commands must be run in PowerShell.

  1. Install GPG from GnuPG.org

  2. If you are downloading Swift packages for the first time, import the PGP keys into your keyring:

    $ gpg.exe keyserver hkp://keyserver.ubuntu.com `
              receive-keys `
              'A62A E125 BBBF BB96 A6E0  42EC 925C C1CC ED3D 1561' `
              '8A74 9566 2C3C D4AE 18D9  5637 FAF6 989E 1BC1 6FEA'
    

    or:

    $ wget https://swift.org/keys/all-keys.asc -UseBasicParsing | Select-Object -Expand Content | gpg.exe import -
    

    Skip this step if you have imported the keys in the past.

  3. Verify the PGP signature.

    The .exe installer for Windows are signed using GnuPG with one of the keys of the Swift open source project. Everyone is strongly encouraged to verify the signatures before using the software.

    First, refresh the keys to download new key revocation certificates, if any are available:

    $ gpg.exe keyserver hkp://keyserver.ubuntu.com refresh-keys Swift
    

    Then, use the signature file to verify that the archive is intact:

    $ gpg.exe verify swift-<VERSION>-<PLATFORM>.exe.sig
    ...
    gpg: Good signature from "Swift Automatic Signing Key #3 <[email protected]>"
    

    If gpg fails to verify because you don’t have the public key (gpg: Can’t check signature: No public key), please follow the instructions in Active Signing Keys below to import the keys into your keyring.

    You might see a warning:

    gpg: WARNING: This key is not certified with a trusted signature!
    gpg:          There is no indication that the signature belongs to the owner.
    

    This warning means that there is no path in the Web of Trust between this key and you. The warning is harmless as long as you have followed the steps above to retrieve the key from a trusted source.

If gpg fails to verify and reports “BAD signature”, do not run the downloaded installer. Instead, please email [email protected] with as much detail as possible, so that we can investigate the problem.

  1. You may install a newer SDK instead.