Skip to content

Update wasm-getting-started.md for 6.2 release #1162

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

Merged
merged 3 commits into from
Sep 17, 2025
Merged

Update wasm-getting-started.md for 6.2 release #1162

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
38b88f1
Update `wasm-getting-started.md` for 6.2 release
MaxDesiatov Sep 17, 2025
f225592
Address PR feedback in `wasm-getting-started.md`
MaxDesiatov Sep 17, 2025
f5638d8
Compute Swift version and tags in `wasm-getting-started.md`
MaxDesiatov Sep 17, 2025
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
26 changes: 15 additions & 11 deletions documentation/articles/wasm-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,28 @@ WebAssembly support in Swift started out as a community project. Any instruction
standardized ABI and system interfaces, and from its inception Wasm support in Swift targeted [WebAssembly System
Interface](https://wasi.dev/), which made porting Swift core libraries to this platform much easier.

With Swift 6.2 and development snapshots you can easily cross-compile and run Wasm modules with Swift SDKs for WASI distributed on [swift.org](https://swift.org/download).
With Swift 6.2 and development snapshots you can easily cross-compile and run Wasm modules with Swift SDKs for Wasm distributed on [swift.org](https://swift.org/download).
The distributed artifact bundles also include support for the experimental Embedded Swift mode.

## Installation

1. [Install `swiftly` per the instructions](https://www.swift.org/install/) for the platform that you're bulding on.

2. Install latest 6.2 development snapshot with `swiftly install 6.2-snapshot`, note the exact snapshot date component in the output of this command.
2. Install Swift 6.2 with `swiftly install 6.2`, note the exact snapshot date component in the output of this command.

3. Select the installed toolchain with `swiftly use 6.2-snapshot`.
3. Select the installed toolchain with `swiftly use 6.2`.

4. Navigate to [the downloads page](https://www.swift.org/download/) and find the “Swift SDK for WASI” section. Find a URL of a version that exactly matches the version from step 2.
If the corresponding snapshot version is not available for the Swift SDK, you’ll have to install the matching toolchain first.
4. Run a command in your terminal application to install Swift SDKs for Wasm.

5. Press "Copy install command" link for the selected Swift SDK to get the installation command, then run it in your terminal application. The command would look like this:
{% assign platform = site.data.builds.swift_releases.last.platforms | where: 'name', 'Wasm'| first %}
{% assign tag = site.data.builds.swift_releases.last.tag %}
{% assign tag_downcase = site.data.builds.swift_releases.last.tag | downcase %}

{% assign base_url = "https://download.swift.org/" | append: tag_downcase | append: "/wasm/" | append: tag | append: "/" | append: tag %}
{% assign command = "swift sdk install " | append: base_url | append: "_wasm.artifactbundle.tar.gz --checksum " | append: platform.checksum %}

```
swift sdk install <swift_sdk_url> --checksum <checksum_value>
{{ command }}
```

6. Run `swift sdk list` to verify the Swift SDK was installed and note its ID in the output. Two Swift SDKs will be installed,
Expand All @@ -41,7 +45,7 @@ one with support for all Swift features, and the other with a subset of features
| `swift-<version>_wasm` | Supports all Swift features |
| `swift-<version>_wasm-embedded` | Supports a subset of features allowed in the experimental [Embedded Swift mode](#embedded-swift-support) |

7. In the future, after installing or selecting a new version of the toolchain with `swiftly` make sure to follow steps 3-6 to install a Swift SDK exactly matching the toolchain version.
7. In the future, after installing or selecting a new version of the toolchain with `swiftly` make sure to install and use an exactly matching Swift SDK version.

## Building and Running

Expand Down Expand Up @@ -72,15 +76,15 @@ struct wasi_test {
Build your package with the following command, substituting the ID from step 5 of [the "Installation" section](#installation) above.

```
swift build --swift-sdk <swift_sdk_id>
swift build --swift-sdk swift-6.2-RELEASE_wasm
```

Recent toolchain snapshots that are compatible with Swift SDKs for WASI also include
Recent toolchain snapshots that are compatible with Swift SDKs for Wasm also include
[WasmKit](https://github.com/swiftwasm/wasmkit/), which is a Wasm runtime that `swift run` can delegate to for
execution. To run the freshly built module, use `swift run` with the same `--swift-sdk` option:

```
swift run --swift-sdk <swift_sdk_id>
swift run --swift-sdk swift-6.2-RELEASE_wasm
```

You should see the following output:
Expand Down