Skip to content

PDI-2080: Update README with Installation Documentation #33

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
erikostien-pingidentity merged 4 commits into from
Nov 18, 2024
Merged

PDI-2080: Update README with Installation Documentation #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
30ad9c6
PDI-2080: Update README with Installation Documentation
erikostien-pingidentity Nov 15, 2024
161b895
Unify shell and powershell on hardcoded tar filename
erikostien-pingidentity Nov 15, 2024
d890dd9
Fix powershell error on http status code check despite error ignore
erikostien-pingidentity Nov 15, 2024
1570176
PDI-2080
erikostien-pingidentity Nov 18, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/goreleaser.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
# either 'goreleaser' (default) or 'goreleaser-pro'
distribution: goreleaser
# 'latest', 'nightly', or a semver
version: latest
version: "~> v2"
args: release --clean
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
50 changes: 49 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,55 @@ The Ping CLI is a unified command line interface for configuring and managing Pi

## Install

<!-- TODO -->
#### macOS/Linux - Homebrew

Use PingIdentity's Homebrew tap to install Ping CLI

```text
brew install pingidentity/tap/pingcli

or

brew tap pingidentity/tap
brew install pingcli
```

#### Manual Installation - macOS/Linux

See [the latest GitHub release](https://github.com/pingidentity/pingcli/releases/latest) for binary downloads and SHA256 checksum files.

OR

Use the following single-line command to install Ping CLI into '/usr/local/bin' directly.

```text
RELEASE_VERSION=$(basename $(curl -Ls -o /dev/null -w %{url_effective} https://github.com/pingidentity/pingcli/releases/latest)); \
OS_NAME=$(uname -s); \
HARDWARE_PLATFORM=$(uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/); \
URL="https://github.com/pingidentity/pingcli/releases/download/${RELEASE_VERSION}/pingcli_${RELEASE_VERSION#v}_${OS_NAME}_${HARDWARE_PLATFORM}.tar.gz"; \
curl -Ls -o pingcli.tar.gz "${URL}"; \
tar -zxf pingcli.tar.gz -C /usr/local/bin pingcli; \
rm -f pingcli.tar.gz
```

#### Manual Installation - Windows

See [the latest GitHub release](https://github.com/pingidentity/pingcli/releases/latest) for binary downloads and SHA256 checksum files.

OR

Use the following single-line powershell command to install Ping CLI into '%LOCALAPPDATA%\Programs' directly.
```text
$latestReleaseUrl = Invoke-WebRequest -Uri "https://github.com/pingidentity/pingcli/releases/latest" -MaximumRedirection 0 -ErrorAction Ignore -UseBasicParsing -SkipHttpErrorCheck; `
$RELEASE_VERSION = [System.IO.Path]::GetFileName($latestReleaseUrl.Headers.Location); `
$RELEASE_VERSION_NO_PREFIX = $RELEASE_VERSION -replace "^v", ""; `
$uname = (uname -m); `
$HARDWARE_PLATFORM = $uname -replace "aarch64", "arm64" -replace "x86_64", "amd64"; `
$URL = "https://github.com/pingidentity/pingcli/releases/download/${RELEASE_VERSION}/pingcli_${RELEASE_VERSION_NO_PREFIX}_windows_${HARDWARE_PLATFORM}.tar.gz"
Invoke-WebRequest -Uri $URL -OutFile pingcli.tar.gz; `
tar -zxf pingcli.tar.gz -C "${env:LOCALAPPDATA}\Programs" pingcli.exe; `
Remove-Item pingcli.tar.gz
```

## Configure Ping CLI

Expand Down