https://github.com/xrdebug/xrdebug

Lightweight debug utility
https://github.com/xrdebug/xrdebug

debug debugger debugging-tool dump php

Last synced: about 1 year ago
JSON representation

Lightweight debug utility

• Host: GitHub
• URL: https://github.com/xrdebug/xrdebug
• Owner: xrdebug
• License: apache-2.0
• Created: 2022-05-22T22:13:43.000Z (about 4 years ago)
• Default Branch: 2.0
• Last Pushed: 2024-10-14T14:31:26.000Z (over 1 year ago)
• Last Synced: 2024-10-29T15:29:31.740Z (over 1 year ago)
• Topics: debug, debugger, debugging-tool, dump, php
• Language: PHP
• Homepage: https://xrdebug.com
• Size: 3.51 MB
• Stars: 75
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# xrDebug





[![Build](https://img.shields.io/github/actions/workflow/status/xrdebug/xrdebug/test.yml?branch=2.0&style=flat-square)](https://github.com/xrdebug/xrdebug/actions)

![Code size](https://img.shields.io/github/languages/code-size/xrdebug/xrdebug?style=flat-square)

[![Apache-2.0](https://img.shields.io/github/license/xrdebug/xrdebug?style=flat-square)](LICENSE)

[![PHPStan](https://img.shields.io/badge/PHPStan-level%209-blueviolet?style=flat-square)](https://phpstan.org/)

[![Mutation testing badge](https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fxrdebug%2Fxrdebug%2F2.0)](https://dashboard.stryker-mutator.io/reports/github.com/xrdebug/xrdebug/2.0)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xrdebug_xrdebug&metric=alert_status)](https://sonarcloud.io/dashboard?id=xrdebug_xrdebug)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=xrdebug_xrdebug&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=xrdebug_xrdebug)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=xrdebug_xrdebug&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=xrdebug_xrdebug)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=xrdebug_xrdebug&metric=security_rating)](https://sonarcloud.io/dashboard?id=xrdebug_xrdebug)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=xrdebug_xrdebug&metric=coverage)](https://sonarcloud.io/dashboard?id=xrdebug_xrdebug)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=xrdebug_xrdebug&metric=sqale_index)](https://sonarcloud.io/dashboard?id=xrdebug_xrdebug)

[![CodeFactor](https://www.codefactor.io/repository/github/xrdebug/xrdebug/badge)](https://www.codefactor.io/repository/github/xrdebug/xrdebug)

[xrDebug](https://xrdebug.com/) is a lightweight web-based debug utility server. 🦄 [Play video](https://xrdebug.com/xrdebug.mp4)

## Installation

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

```sh

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

```



    





    



## Documentation

Documentation available at [docs.xrdebug.com](https://docs.xrdebug.com/).

## Features

* Ephemeral, it doesn't store any persistent data

* Signed requests (Ed25519)

* End-to-end encryption (AES-GCM AE)

* Filter messages by Topics and Emotes

* Resume, Pause, Stop and Clear debug window controls

* Keyboard shortcuts (Resume **R**, Pause **P**, Stop **S** and Clear **C**)

* Re-name "xrDebug" session to anything you want

* Export dump output to clipboard or as PNG image

* Pause and resume your code execution

* Dark / Light mode follows your system preferences

* Portable & HTML based (save page, search, etc.)

* Uses [FiraCode](https://github.com/tonsky/FiraCode) font for displaying _beautiful looking dumps_ ™

* Open with editor links

* Responsive user interface



    





    



## PHP Features

* Configuration via code and `xr.php` file

* Dump arguments using [VarDump](https://chevere.org/packages/var-dump.html)

* Generates dump backtrace

* Custom inspectors

* Handle errors and exceptions (hook or replace your existing handler)

## License

Copyright [Rodolfo Berrios A.](https://rodolfoberrios.com/)

xrDebug is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.