PowerShell/docs/install-github-cli.md

73 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2024-11-08 12:38:20 +01:00
The *install-github-cli.ps1* Script
===========================
2021-11-08 21:36:42 +01:00
2023-09-01 17:53:03 +02:00
This PowerShell script installs the GitHub command-line interface (CLI).
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2024-11-08 12:35:11 +01:00
/home/markus/Repos/PowerShell/scripts/install-github-cli.ps1 [<CommonParameters>]
2021-11-08 21:36:42 +01:00
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-09-01 17:53:03 +02:00
Example
-------
```powershell
PS> ./install-github-cli.ps1
⏳ Installing GitHub CLI...
2024-11-08 12:35:11 +01:00
✔ GitHub CLI installed successfully in 17s - to authenticate execute: 'gh auth login'.
2023-09-01 17:53:03 +02:00
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Installs GitHub CLI
.DESCRIPTION
2023-09-01 17:53:03 +02:00
This PowerShell script installs the GitHub command-line interface (CLI).
2022-11-17 20:02:26 +01:00
.EXAMPLE
2023-08-06 21:36:33 +02:00
PS> ./install-github-cli.ps1
2023-09-01 17:53:03 +02:00
⏳ Installing GitHub CLI...
2024-11-08 12:35:11 +01:00
✔ GitHub CLI installed successfully in 17s - to authenticate execute: 'gh auth login'.
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
try {
2023-09-01 17:53:03 +02:00
"⏳ Installing GitHub CLI..."
2024-11-08 12:35:11 +01:00
$stopWatch = [system.diagnostics.stopwatch]::startNew()
2022-11-17 20:02:26 +01:00
if ($IsMacOS) {
2023-08-06 21:36:33 +02:00
& brew install gh
2022-11-17 20:02:26 +01:00
} elseif ($IsLinux) {
2023-09-01 17:53:03 +02:00
& sudo apt install gh
2023-08-06 21:36:33 +02:00
} else {
& winget install --id GitHub.cli
2024-11-08 12:35:11 +01:00
if ($lastExitCode -ne "0") { throw "Installation of GitHub CLI failed, maybe it's already installed." }
2023-09-01 17:53:03 +02:00
}
2024-11-08 12:35:11 +01:00
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✅ GitHub CLI installed successfully in $($elapsed)s - to authenticate execute: 'gh auth login'"
2022-11-17 20:02:26 +01:00
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2024-11-20 11:52:20 +01:00
*(generated by convert-ps2md.ps1 as of 11/20/2024 11:51:54)*