Skip to content

Commit 08dcfaa

Browse files
committed
Update documentation
1 parent 5841733 commit 08dcfaa

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -541,3 +541,81 @@ The script will receive the argument '+abcde' followed by '+xyz'.
541541

542542

543543

544+
## link
545+
546+
Link swiftly so it resumes management of the active toolchain.
547+
548+
```
549+
swiftly link [<toolchain-selector>] [--assume-yes] [--verbose] [--version] [--help]
550+
```
551+
552+
**toolchain-selector:**
553+
554+
*Links swiftly if it has been disabled.*
555+
556+
557+
Links swiftly if it has been disabled.
558+
559+
560+
**--assume-yes:**
561+
562+
*Disable confirmation prompts by assuming 'yes'*
563+
564+
565+
**--verbose:**
566+
567+
*Enable verbose reporting from swiftly*
568+
569+
570+
**--version:**
571+
572+
*Show the version.*
573+
574+
575+
**--help:**
576+
577+
*Show help information.*
578+
579+
580+
581+
582+
## unlink
583+
584+
Unlinks swiftly so it no longer manages the active toolchain.
585+
586+
```
587+
swiftly unlink [<toolchain-selector>] [--assume-yes] [--verbose] [--version] [--help]
588+
```
589+
590+
**toolchain-selector:**
591+
592+
*Unlinks swiftly, allowing the system default toolchain to be used.*
593+
594+
595+
Unlinks swiftly until swiftly is linked again with:
596+
597+
$ swiftly link
598+
599+
600+
**--assume-yes:**
601+
602+
*Disable confirmation prompts by assuming 'yes'*
603+
604+
605+
**--verbose:**
606+
607+
*Enable verbose reporting from swiftly*
608+
609+
610+
**--version:**
611+
612+
*Show the version.*
613+
614+
615+
**--help:**
616+
617+
*Show help information.*
618+
619+
620+
621+

0 commit comments

Comments
 (0)