Install WP Staging CLI

This guide explains how to install WP Staging CLI on your computer. The CLI tool lets you extract, restore, and manage WordPress backups from the command line.

What You’ll Need

• A valid WP Staging Pro license (Agency or Developer plan)
• For extract/restore: Any modern system with 512 MB RAM
• For Docker features: 2 CPU cores, 4 GB RAM, Docker 20.10.0+, Docker Compose 2.19.0+

Quick Install (Recommended)

The installer automatically downloads the correct version for your operating system, verifies checksums, and adds the command to your PATH.

Linux, macOS, WSL:

curl -fsSL https://wp-staging.com/install.sh | bash

Windows PowerShell:

irm https://wp-staging.com/install.ps1 | iex

Windows CMD:

curl -fsSL https://wp-staging.com/install.cmd -o install.cmd && install.cmd && del install.cmd

Install a Specific Version

Check whether a newer version is available

wpstaging update --check

Install the latest version

wpstaging update

To install a specific version including beta, alpha, or release candidate versions. (Upgrade or downgrade):

wpstaging update --version 1.9.1

See all available versions at GitHub Releases.

Manual Installation

If you prefer to download and install manually:

1. Download the latest release archive from GitHub Releases (main.zip)
2. Extract the archive and locate the binary in the build folder for your platform:
   • Linux: build/linux_amd64/wpstaging (64-bit) or build/linux_i386/wpstaging (32-bit)
   • macOS: build/macos_arm64/wpstaging (Apple Silicon) or build/macos_amd64/wpstaging (Intel)
   • Windows: build/windows_amd64/wpstaging.exe (64-bit) or build/windows_i386/wpstaging.exe (32-bit)
3. Make it accessible from anywhere on your computer (see below)

Linux, macOS (User Installation):

# User installation (no sudo required)
mkdir -p ~/.local/bin
mv wpstaging ~/.local/bin/
chmod +x ~/.local/bin/wpstaging

Linux, macOS (System-wide Installation):

sudo mv wpstaging /usr/local/bin/
sudo chmod +x /usr/local/bin/wpstaging

Windows:

1. Create a directory: C:\Program Files\wpstaging\
2. Move wpstaging.exe to that directory
3. Add C:\Program Files\wpstaging\ to your PATH environment variable

Verify Installation

After installation, verify it’s working by checking the version:

wpstaging --version

You should see output similar to:

wpstaging version 1.5.1

To see all available commands:

wpstaging --help

Uninstallation

To remove WP Staging CLI from your system:

Minimal: deactivates the license and removes the binary, completion files, and PATH entries

wpstaging uninstall

Full: also runs the install script’s removal flow (cache, Docker sites, etc.)

wpstaging uninstall --full

Or Download and run the uninstaller directly:

Linux, macOS, WSL:

curl -fsSL https://wp-staging.com/uninstall.sh | bash

Windows Powershell:

irm https://wp-staging.com/uninstall.ps1 | iex

Windows CMD:

url -fsSL https://wp-staging.com/uninstall.cmd -o uninstall.cmd && uninstall.cmd && del uninstall.cmd

Next Steps

After installation, you’ll need to register your license before using the CLI:

• Register Your License
• Extract Backup Files
• Create a Local Copy of WordPress Site