Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pingidentity/pingcli
https://github.com/pingidentity/pingcli
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/pingidentity/pingcli
- Owner: pingidentity
- License: apache-2.0
- Created: 2024-09-27T21:04:41.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-12T18:59:10.000Z (22 days ago)
- Last Synced: 2024-12-12T19:25:53.378Z (22 days ago)
- Language: Go
- Size: 452 KB
- Stars: 1
- Watchers: 6
- Forks: 0
- 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
#### 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
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.
## 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.