https://github.com/pingidentity/pingcli
A unified command line interface for configuring and managing Ping Identity Services
https://github.com/pingidentity/pingcli
pingfederate pingone terraform
Last synced: 3 months ago
JSON representation
A unified command line interface for configuring and managing Ping Identity Services
- Host: GitHub
- URL: https://github.com/pingidentity/pingcli
- Owner: pingidentity
- License: apache-2.0
- Created: 2024-09-27T21:04:41.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-03-25T20:12:41.000Z (3 months ago)
- Last Synced: 2025-03-25T20:36:24.380Z (3 months ago)
- Topics: pingfederate, pingone, terraform
- Language: Go
- Homepage:
- Size: 950 KB
- Stars: 1
- Watchers: 6
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Ping CLI
The Ping CLI is a unified command line interface for configuring and managing Ping Identity Services.
## Install
### Docker
Use the [Ping CLI Docker image](https://hub.docker.com/r/pingidentity/pingcli)
Pull Image:
```shell
docker pull pingidentity/pingcli:latest
```
Example Commands:
```shell
docker run
docker run --version
```
### macOS
##### Homebrew
Use PingIdentity's Homebrew tap to install Ping CLI
```shell
brew install pingidentity/tap/pingcli
```
OR
``` shell
brew tap pingidentity/tap
brew install pingcli
```
##### Manual Installation
See [the latest GitHub release](https://github.com/pingidentity/pingcli/releases/latest) for artifact downloads, artifact signatures, and the checksum file. To verify package downloads, see the [Verify Section](#verify).
OR
Use the following single-line command to install Ping CLI into '/usr/local/bin' directly.
```shell
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}"; \
curl -Ls -o pingcli "${URL}"; \
mv pingcli /usr/local/bin/pingcli;
```
### Linux
##### Homebrew
Use PingIdentity's Homebrew tap to install Ping CLI
```shell
brew install pingidentity/tap/pingcli
```
OR
``` shell
brew tap pingidentity/tap
brew install pingcli
```
##### Alpine (.apk)
See [the latest GitHub release](https://github.com/pingidentity/pingcli/releases/latest) for Alpine (.apk) package downloads. To verify package downloads, see the [Verify Section](#verify).
```shell
apk add --allow-untrusted pingcli__linux_amd64.apk
apk add --allow-untrusted pingcli__linux_arm64.apk
```
##### Debian/Ubuntu (.deb)
See [the latest GitHub release](https://github.com/pingidentity/pingcli/releases/latest) for Debian (.deb) package downloads. To verify package downloads, see the [Verify Section](#verify).
```shell
apt-get install pingcli__linux_amd64.deb
apt-get install pingcli__linux_arm64.deb
```
##### CentOS/Fedora/RHEL (.rpm)
See [the latest GitHub release](https://github.com/pingidentity/pingcli/releases/latest) for RPM (.rpm) package downloads. To verify package downloads, see the [Verify Section](#verify).
```shell
yum install pingcli__linux_amd64.rpm
yum install pingcli__linux_arm64.rpm
dnf install pingcli__linux_amd64.rpm
dnf install pingcli__linux_arm64.rpm
```
##### Manual Installation
See [the latest GitHub release](https://github.com/pingidentity/pingcli/releases/latest) for artifact downloads, artifact signatures, and the checksum file. To verify package downloads, see the [Verify Section](#verify).
OR
Use the following single-line command to install Ping CLI into '/usr/local/bin' directly.
```shell
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}"; \
curl -Ls -o pingcli "${URL}"; \
mv pingcli /usr/local/bin/pingcli;
```
### Windows
##### Manual Installation
See [the latest GitHub release](https://github.com/pingidentity/pingcli/releases/latest) for artifact downloads, artifact signatures, and the checksum file. To verify package downloads, see the [Verify Section](#verify).
OR
Use the following single-line PowerShell 7.4 command to install Ping CLI into '%LOCALAPPDATA%\Programs' directly.
```powershell
$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", ""; `
$HARDWARE_PLATFORM = $env:PROCESSOR_ARCHITECTURE -replace "ARM64", "arm64" -replace "x86", "386" -replace "AMD64", "amd64" -replace "EM64T", "amd64"; `
$URL = "https://github.com/pingidentity/pingcli/releases/download/${RELEASE_VERSION}/pingcli_${RELEASE_VERSION_NO_PREFIX}_windows_${HARDWARE_PLATFORM}"
Invoke-WebRequest -Uri $URL -OutFile "pingcli.exe"; `
Move-Item -Path pingcli.exe -Destination "${env:LOCALAPPDATA}\Programs"
```
## Verify
### Checksums
See [the latest GitHub release](https://github.com/pingidentity/pingcli/releases/latest) for the checksums.txt file. The checksums are in the format of SHA256.
### GPG Signatures
See [the latest GitHub release](https://github.com/pingidentity/pingcli/releases/latest) for the artifact downloads and signature files.
##### Add our public GPG Key via OpenPGP Public Key Server
```shell
gpg --keyserver keys.openpgp.org --recv-key 0x6703FFB15B36A7AC
```
##### Add our public GPG Key via MIT PGP Public Key Server
```shell
gpg --keyserver keys.openpgp.org --recv-key 0x6703FFB15B36A7AC
```
##### Verify Artifact via Signature File
```shell
gpg --verify .sig
```
## Configure Ping CLI
Before using the Ping CLI, you need to configure your Ping Identity Service profile(s). The following steps show the quickest path to configuration.
Start by running the command to create a new profile and answering the prompts.
```text
$ pingcli config add-profile
Pingcli configuration file '/Users//.pingcli/config.yaml' does not exist. - No Action (Warning)
Creating new Ping CLI configuration file at: /Users//.pingcli/config.yaml
New profile name: : dev
New profile description: : configuration for development environment
Set new profile as active: : y
Adding new profile 'dev'...
Profile created. Update additional profile attributes via 'pingcli config set' or directly within the config file at '/Users//.pingcli/config.yaml' - Success
Profile 'dev' set as active. - Success
```
The newly create profile can now be configured via the `pingcli config set` command. General Ping Identity service connection settings are found under the `service` key, and settings relevant to individual commands are found under their command names e.g. `export` and `request`.
See [Configuration Key Documentation](./docs/tool-configuration/configuration-key.md) for more information on configuration keys
and their purposes.
See [Autocompletion Documentation](./docs/autocompletion/autocompletion.md) for information on loading autocompletion for select command flags.
## Commands
Ping CLI commands have the following structure:
```shell
pingcli [options and parameters]
```
To get the version of Ping CLI:
```shell
pingcli --version
```
### Platform Export
The `pingcli platform export` command uses your configured settings to connect to the requested services and generate [Terraform import blocks](https://developer.hashicorp.com/terraform/language/import) for every supported resource available.
An example command to export a PingOne environment for HCL generation looks like:
```shell
pingcli platform export --services "pingone-platform,pingone-sso"
```
The generated import blocks are organized into one folder with a file per resource type found. These import blocks can be used to [generate terraform configuration](https://developer.hashicorp.com/terraform/language/import/generating-configuration).
### Custom Request
The `pingcli request` command uses your configured settings to authenticate to the desired ping service before executing your API request.
An example command to view PingOne Environments looks like:
```shell
pingcli request --http-method GET --service pingone environments
```
## Getting Help
The best way to interact with our team is through Github. You can [open an issue](https://github.com/pingidentity/pingcli/issues/new) for guidance, bug reports, or feature requests.
Please check for similar open issues before opening a new one.