Skip to content

Document the TMPDIR environment variable for better discovery #308

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 6 commits into from
Apr 7, 2025
Merged

Document the TMPDIR environment variable for better discovery #308

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
62e36bb
Add documentation about the TMPDIR environment variable for better di…
cmcgee1024 Apr 7, 2025
e1589ce
Update Documentation/SwiftlyDocs.docc/automated-install.md
cmcgee1024 Apr 7, 2025
4f1a834
Update Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md
cmcgee1024 Apr 7, 2025
2769279
Update Sources/Swiftly/Install.swift
cmcgee1024 Apr 7, 2025
43260b0
Regenerate the CLI reference
cmcgee1024 Apr 7, 2025
28600ff
Fix bad merge
cmcgee1024 Apr 7, 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
1 change: 1 addition & 0 deletions Documentation/SwiftlyDocs.docc/automated-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ If you want to install swiftly, or the binaries that it manages into different l

- term `SWIFTLY_HOME_DIR`: The location of the swiftly configuration files, and environment scripts
- term `SWIFTLY_BIN_DIR`: The location of the swiftly binary and toolchain symbolic links (for example swift, swiftc, and so on)
- term `TMPDIR`: The temporary directory to be used by swiftly for temporary files, such as downloads that can be very large until they are cleaned up.

Sometimes swiftly can't automatically detect the system platform, or isn't supported by swift.
You can provide the platform as an option to the `swiftly init` subcommand:
Expand Down
6 changes: 5 additions & 1 deletion Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,14 @@ Likewise, the latest snapshot associated with a given development branch can be
$ swiftly install 5.7-snapshot
$ swiftly install main-snapshot

Install whatever toolchain is currently selected, such as the the one in the .swift-version file:
Install whatever toolchain is currently selected, such as the the one in the .swift-version file:

$ swiftly install

NOTE: Toolchains are downloaded to a temporary file that is later cleaned up by the installation process. If these files are too big for your usual temporary directory you can choose another location by setting the `TMPDIR` environment variable.

$ TMPDIR=/large/file/tmp/storage swiftly install latest


**--use:**

Expand Down
8 changes: 7 additions & 1 deletion Sources/Swiftly/Install.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,15 @@ struct Install: SwiftlyCommand {
$ swiftly install 5.7-snapshot
$ swiftly install main-snapshot

Install whatever toolchain is currently selected, such as the the one in the .swift-version file:
Install whatever toolchain is currently selected, such as the the one in the .swift-version file:

$ swiftly install

NOTE: Toolchains are downloaded to a temporary file that is later cleaned up by the installation \
process. If these files are too big for your usual temporary directory you can choose another location \
by setting the `TMPDIR` environment variable.

$ TMPDIR=/large/file/tmp/storage swiftly install latest
"""
))
var version: String?
Expand Down