yasd - GitLite

KO | EN

gitlite — search

#hacktoberfest #llm #go #android #rust #linux #awesome #cli #kubernetes #vue #awesome-list #pytorch #mcp #openai

yasd

(★ 360)

Yet Another Swoole Debugger

File Explorer

Download Latest Version (.zip)

- - alpine.Dockerfile
  - ext.yml
- ISSUE_TEMPLATE
- base.h
- base64.h
- buffer.h
- cmder_debugger.h
- common.h
- context.h
- dbgp.h
- debuger_mode_base.h
- global.h
- logger.h
- redirect_file_to_cin.h
- remote_debugger.h
- source_reader.h
- util.h
- watch_point.h
- zend_property_info.h
- analyze_function.php
- trace_function.php
- base.cc
- base64.cc
- buffer.cc
- cmder_debugger.cc
- common.cc
- context.cc
- dbgp.cc
- debuger_mode_base.cc
- global.cc
- logger.cc
- remote_debugger.cc
- source_reader.cc
- util.cc
- - swoole.ini
  - yasd.ini
- - bootstrap.php
- - DbgpClient.php
- clean
- inc_template
- new.php
- README.md
- run-tests
- start.sh
- template
- - tinyxml2.cc
  - tinyxml2.h
.clang-format
.gitignore
.php_cs
composer.json
composer.lock
config.m4
header.php
init_file.php
LICENSE
php_yasd.h
php_yasd_cxx.cc
php_yasd_cxx.h
README-CN.md
README.md
test.php
yasd.cc
yasd_api.cc
yasd_api.h
yasd_api.stub.php
yasd_function_status.cc
yasd_function_status.h

# Installation Guide

1. Get the code

git clone https://github.com/swoole/yasd

Downloads the entire project code from GitHub to your computer.

cd yasd

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Homebrew A package manager for macOS/Linux.
APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.

brew install boost

Installs the pre-built package via Homebrew — no source build required.

apt-get install libboost-all-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. PHP (Composer)

Easy

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer dump-autoload -o

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

English | [中文](./README-CN.md)

# yasd

> Swoole 5.0.1 + PHP 8.1 already support xdebug, so there is no need to use the yasd debugger!

Yet Another Swoole Debugger. [document](https://huanghantao.github.io/yasd-wiki/)

## How to use it

**Notice: if you use Swoole\Server, set the `worker_num` to 1, otherwise the breakpoint may fail.**

### build

You'll need to install the Boost library first.

macOS:

```bash
brew install boost
```

Ubuntu:

```bash
apt-get install libboost-all-dev
```

CentOS:

```bash
yum install boost boost-devel
```

```bash
phpize --clean && \
phpize && \
./configure && \
make clean && \
make && \
make install
```

set the ini file:

```ini
zend_extension=yasd
```

see the extension info:

```bash
php --ri yasd
```

### IDE debug mode

```ini
zend_extension=yasd
yasd.debug_mode=remote
yasd.remote_host=127.0.0.1
yasd.remote_port=9000
```

### cmd debug mode

All command supports fuzzy matching of priorities.

set the ini file:

```ini
zend_extension=yasd
yasd.debug_mode=cmd
```

#### start debug

```bash
php -e test.php
```

#### list

```bash
l
```

list source code

#### breakpoint

```bash
b absolute-file-path lineno
```

This will also save the breakpoint information in the cache file -- `.breakpoints_file.log`

You can change this file name by the ini file, e.g.

```ini
yasd.breakpoints_file="yasd.log"
```

If the cache file exists, the breakpoints in the file are automatically loaded when debug is started.

#### Delete breakpoints

```bash
d number
```

If a breakpoint is set or deleted without specifying `absolute-file-path`, It will set breakpoint in the current file.

#### watch point

We can monitor the variable changes or expression, for example:

```cpp
watch $a
```

```cpp
watch $a > 10
```

```cpp
watch $name == 'swoole'
```

#### unwatch point

```cpp
unwatch number
```

#### run

```bash
r
```

#### step over

```bash
n
```

#### step into

```bash
s
```

#### step out

```bash
f
```

#### backtrace

```bash
bt
```

#### info

show all breakpoints:

```bash
info breakpoints
```

show all watchpoints:

```bash
info watchpoints
```

#### continue

```bash
c
```

#### quit

```bash
q
```

#### print

```bash
p $a
p $this
p $this->prop
```

#### level

```bash
le
```

### Q&A

#### Debugging with phpstorm (remote mode)

- the port phpstorm listens on should be the one used for xdebug, also make sure remote connections are allowed:
![image](https://user-images.githubusercontent.com/21345604/109924706-c2044180-7cd1-11eb-80a1-79af023ea01e.png)
- do **NOT** forget to use `-e` option when running scripts, debugging will not work otherwise

- ensure that phpstorm listens on incoming connections:

![image](https://user-images.githubusercontent.com/21345604/109924880-042d8300-7cd2-11eb-9972-002806afbb6c.png)

#### Slow Start Framework

When using `yasd`, if the framework starts slowly (most of the time it's because the framework is scanning a lot of files), you can execute the following command.

##### Hyperf

```bash
composer dump-autoload -o
```

Then modify the following configuration `config/config.php`:

```php
'scan_cacheable' => env('SCAN_CACHEABLE', true)
```

##### Imi

We did not find a slow start problem.

##### EasySwoole

We did not find a slow start problem.

##### MixPHP

We did not find a slow start problem.

##### Swoft

We did not find a slow start problem.

##### One

We did not find a slow start problem.

#### The breakpoint is not triggered

1. No absolute path to the file is used
2. The breakpoint is not a valid line, such as a function declaration, blank line, etc
3. The code is generated with proxy classes, such as Hyperf. So you need to set breakpoints in the proxy class.