PowerShell/Docs/switch-branch.ps1.md

54 lines
1.3 KiB
Markdown
Raw Normal View History

2021-08-30 15:51:59 +02:00
# Help for switch-branch.ps1 PowerShell Script
2021-08-29 12:44:05 +02:00
2021-08-29 18:27:03 +02:00
## Synopsis & Description
2021-08-29 18:05:09 +02:00
```powershell
2021-08-29 12:44:05 +02:00
switch-branch.ps1 [<branch-name>] [<repo-dir>]
2021-08-29 18:05:09 +02:00
```
2021-08-29 12:44:05 +02:00
2021-08-29 18:05:09 +02:00
Switches the branch in the current/given Git repository (including submodules).
2021-08-29 12:44:05 +02:00
2021-08-29 18:21:53 +02:00
## Syntax & Parameters
2021-08-29 12:44:05 +02:00
```powershell
/home/mf/PowerShell/Scripts/switch-branch.ps1 [[-BranchName] <String>] [[-RepoDir] <String>] [<CommonParameters>]
```
```
-BranchName <String>
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
```
```
-RepoDir <String>
Required? false
Position? 2
Default value "$PWD"
Accept pipeline input? false
Accept wildcard characters? false
```
2021-08-29 18:12:58 +02:00
```
2021-08-29 18:21:53 +02:00
[<CommonParameters>]
2021-08-29 18:12:58 +02:00
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2021-08-29 12:44:05 +02:00
## Example
```powershell
PS>.\switch-branch.ps1 main C:\MyRepo
```
## Notes
2021-08-29 18:05:09 +02:00
Author: Markus Fleschutz · License: CC0
2021-08-29 12:44:05 +02:00
## Related Links
https://github.com/fleschutz/PowerShell
2021-08-30 15:48:23 +02:00
*Generated from comment-based help of switch-branch.ps1 by convert-ps2md.ps1*