Skip to content

Update swiftly install one-liner and instructions #936

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 5 commits into from
Mar 27, 2025
Merged

Update swiftly install one-liner and instructions #936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc2fb15
Update the one-liners to explicitly set a swiftly home dir so that th…
cmcgee1024 Mar 27, 2025
ff37d0b
Add notes about the environment variables and install location custom…
cmcgee1024 Mar 27, 2025
a52a553
Fix awkward wording in install note.
cmcgee1024 Mar 27, 2025
575c971
Fix awkward wording in macOS install note
cmcgee1024 Mar 27, 2025
33edfab
Adjust the one-liners and installation pages for macOS and Linux
cmcgee1024 Mar 27, 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
4 changes: 3 additions & 1 deletion install/linux/swiftly/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Run the following command in your terminal, to configure swiftly for your accoun
./swiftly init
```

Note: You can set the SWIFTLY_HOME_DIR and SWIFTLY_BIN_DIR environment variables to customize your install location.

Your current shell may need some additional steps to update your session. Follow the guidance at the end of the installation for a smooth install experience, such as sourcing the environment file, and rehashing your shell's PATH.

There can be certain packages that need to be installed on your system so that the Swift toolchain can function. The swiftly initialization routine will show you how to install any missing packages.
Expand Down Expand Up @@ -64,4 +66,4 @@ Check for updates to swiftly and install them by running the self-update command
swiftly self-update
```

You can discover more about swiftly in the [documentation](https://www.swift.org/swiftly/documentation/swiftlydocs/)
You can discover more about swiftly in the [documentation](https://www.swift.org/swiftly/documentation/swiftlydocs/)
4 changes: 2 additions & 2 deletions install/macos/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ title: Install Swift
<h4>Run this in a terminal:</h4>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><button>Copy</button><pre class="highlight"><code>curl -O https://download.swift.org/swiftly/darwin/swiftly-{{ site.data.builds.swiftly_release.version }}.pkg &amp;&amp; \
installer -pkg swiftly-{{ site.data.builds.swiftly_release.version }}.pkg -target CurrentUserHomeDirectory &amp;&amp; \
~/usr/local/bin/swiftly init --quiet-shell-followup &amp;&amp; \
. ~/Library/Application\ Support/swiftly/env.sh &amp;&amp; \
~/.swiftly/bin/swiftly init --quiet-shell-followup &amp;&amp; \
. ~/.swiftly/env.sh &amp;&amp; \
hash -r
</code></pre></div></div>
<h4>License: <a href="https://raw.githubusercontent.com/swiftlang/swiftly/refs/heads/main/LICENSE.txt">Apache-2.0</a></h4>
Expand Down
4 changes: 3 additions & 1 deletion install/macos/swiftly/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ installer -pkg swiftly-{{ site.data.builds.swiftly_release.version }}.pkg -targe
Run the following command in your terminal, to configure swiftly for your account, and automatically download the latest swift toolchain.

```
~/usr/local/bin/swiftly init
~/.swiftly/bin/swiftly init
```

Note: You can set the SWIFTLY_HOME_DIR and SWIFTLY_BIN_DIR environment variables to customize the install location.

<div class="warning" markdown="1">
Your current shell may need some additional steps to update your session. Follow the guidance at the end of the installation for a smooth install experience, such as sourcing the environment file, and rehashing your shell's PATH.
</div>
Expand Down