# Installation
xrDebug is available as a self-contained binary, PHAR file, Composer package, Docker image, and source code. See run for instructions on how to run the software.
xrDebug is available for macOS, Linux, and Windows WSL. Access to the latest release (opens new window) artifacts at GitHub.
# Self-contained binary recommended
Download latest xrdebug binary by running the following command in your terminal, it detects your operating system and CPU architecture (macOS/Linux) and installs the binary at /usr/local/bin:
bash <(curl -sL xrdebug.com/bin.sh)
# Self-contained binary (manual)
Download latest xrdebug binary for your operating system and CPU architecture.
# macOS
Download the .tar.gz file for your CPU architecture.
| CPU | Download |
|---|---|
| Silicon | xrdebug-macos-arm64.tar.gz (opens new window) |
| Intel | xrdebug-macos-x86_64.tar.gz (opens new window) |
Run the following to install xrDebug on macOS from your terminal:
# Linux & Windows WSL
Download the .tar.gz file for your CPU architecture.
| CPU | Download |
|---|---|
| aarch64 | xrdebug-linux-aarch64.tar.gz (opens new window) |
| x86_64 | xrdebug-linux-x86_64.tar.gz (opens new window) |
Run the following to install xrDebug on Linux from your terminal:
# Binary on PATH
Once extracted and with executable permissions set, the xrDebug software will be available to run as:
./xrdebug
Run the following command to move the downloaded binary to a directory in your PATH:
mv xrdebug /usr/local/bin/xrdebug
After moving the binary to a directory within PATH the xrDebug software will be available system wide as:
xrdebug
# PHAR
Download latest xrdebug.phar (opens new window) file.
Run the following command to download and verify xrDebug .phar from terminal:
# download
curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug.phar
curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug.phar.asc
# verify
gpg --recv-keys 75BD018B5EB1DAC838C358414B997D0D617BB354
gpg --with-fingerprint --verify xrdebug.phar.asc xrdebug.phar
The xrDebug software will be available to run as:
php xrdebug.phar
# Source
To install from source clone the repository (opens new window) and install dependencies using Composer (opens new window).
git clone https://github.com/xrdebug/xrdebug.git
cd xrdebug
composer install
The xrDebug software will be available to run as:
./xrdebug
# Packagist
Use package xrdebug/xrdebug (opens new window) to install as a dependency for your project using Composer (opens new window):
composer require --dev xrdebug/xrdebug
The xrDebug dependency server software will be available at:
vendor/bin/xrdebug
# Docker
Container images are available at ghcr.io/xrdebug/xrdebug (opens new window).
Run the following command to start the server at port 27420:
docker run -t --init --rm -p 27420:27420 ghcr.io/xrdebug/xrdebug