Configuration Automation - Ping CLI

Install and update on Windows

Ping CLI is available for Windows as a standalone executable. This page covers downloading and installing Ping CLI on Windows systems.

System requirements

  • Windows 7 or later

  • PowerShell 5.1 or later

Installation

Download and install Ping CLI using PowerShell. Visit the latest GitHub release to download the Windows executable.

Alternatively, use this PowerShell command to download and install the latest version:

$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); `
$URL = "https://github.com/pingidentity/pingcli/releases/download/${RELEASE_VERSION}/pingcli_windows_amd64.exe"; `
Invoke-WebRequest -Uri $URL -OutFile "pingcli.exe"

Move the executable to a location on your system PATH, or add the directory to your system PATH environment variable.

Verify the installation

After installation, open a PowerShell window and verify that Ping CLI is properly installed:

pingcli --version

You should see output similar to:

pingcli version 1.0.0

Upgrading the CLI binary

When you upgrade Ping CLI, your existing configuration files are automatically migrated to the new format on first run. This process is safe and includes automatic backups.

Download the new executable from the latest GitHub release and replace the existing one, or use this PowerShell command to download and install the latest version:

$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); `
$URL = "https://github.com/pingidentity/pingcli/releases/download/${RELEASE_VERSION}/pingcli_windows_amd64.exe"; `
Invoke-WebRequest -Uri $URL -OutFile "pingcli.exe"

Replace the old executable with this new version and verify the upgrade:

pingcli --version

Configuration migration

When you run Ping CLI after upgrading, the tool automatically detects the old configuration format and creates a migration plan. If you’re running interactively, you’ll be prompted to approve the migration. The CLI will:

  1. Back up your existing config file (with a timestamp, for example, config.yaml.backup.20260605T123456Z)

  2. Show you what changes will be made

  3. Apply the migration safely (atomic write)

For non-interactive environments (CI/CD scripts), set the following environment variable to auto-approve migration:

$env:PINGCLI_CONFIG_MIGRATION_POLICY = "yes"

Then run your Ping CLI command as usual.

Uninstalling Ping CLI

Uninstall manual installation

To remove Ping CLI, delete the executable from your system PATH:

Remove-Item -Path "C:\path\to\pingcli.exe"

Or if you placed it in a directory on your PATH, use File Explorer to navigate to that location and delete pingcli.exe.

Removing configuration files (optional)

Ping CLI configuration files are stored in your user’s home directory and are not automatically removed when you uninstall the binary. To manually remove them:

Remove-Item -Path $env:USERPROFILE\.pingcli -Recurse -Force

Next steps

Now that Ping CLI is installed, proceed to: