Skip to content

Latest commit

 

History

History
141 lines (100 loc) · 4.22 KB

README.md

File metadata and controls

141 lines (100 loc) · 4.22 KB
Raw
sidebarDepth
2

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 artifacts at GitHub.

Self-contained binary

Download latest xrdebug binary by running the following command in your terminal, it detects your operating system and CPU architecture:

bash <(curl -sL xrdebug.com/bin.sh)

Self-contained binary (manual)

Download latest xrdebug binary for your operating system and CPU architecture.

macOS

xrDebug package for macOS includes a GUI install wizard. Open the .pkg file to start the installation.

CPU Download
Silicon xrdebug-macos-arm64.pkg
Intel xrdebug-macos-x86_64.pkg

::: details CLI instructions Run the following to install from your terminal:

```sh curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-macos-arm64.pkg open xrdebug-macos-arm64.pkg ``` ```sh curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-macos-x86_64.pkg open xrdebug-macos-x86_64.pkg ``` :::

Linux & Windows WSL

Download the .tar.gz file for your CPU architecture and extract it to a directory in your PATH.

CPU Download
aarch64 xrdebug-linux-aarch64.tar.gz
x86_64 xrdebug-linux-x86_64.tar.gz

::: details CLI instructions Run the following to install from your terminal:

```sh curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-linux-aarch64.tar.gz tar -xvf xrdebug-linux-aarch64.tar.gz ``` ```sh curl -LO https://github.com/xrdebug/xrdebug/releases/latest/download/xrdebug-linux-x86_64.tar.gz tar -xvf xrdebug-linux-x86_64.tar.gz ``` :::

PHAR

Download latest xrdebug.phar file.

::: details CLI instructions To download and verify 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

:::

Source

To install from source clone the repository:

git clone https://github.com/xrdebug/xrdebug.git

Install dependencies using Composer:

composer install

The command will be available at:

./xrdebug

Packagist

Use package xrdebug/xrdebug to install as a dependency for your project using Composer:

composer require --dev xrdebug/xrdebug

The dependency server will be available at:

vendor/bin/xrdebug

Docker

Container images are available at ghcr.io/xrdebug/xrdebug.

Run the following command to start the server at port 27420:

docker run -t --init --rm -p 27420:27420 ghcr.io/xrdebug/xrdebug