Skip to content

Commit eda5209

Browse files
committed
Update documentation
1 parent 20b6a62 commit eda5209

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
@@ -545,3 +545,81 @@ The script will receive the argument '+abcde' followed by '+xyz'.
545545

546546

547547

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

0 commit comments

Comments
 (0)