How can I use xdebug with wp-cli

Question

I'd like to use xdebug and vscode to debug a script I'm running via wp eval-file.

My launch.json is pretty basic.

    {
            "name": "Listen for Xdebug",
            "type": "php",
            "request": "launch",
            "port": 9003
    }

my php.ini has xdebug config, and debugging a simple stand-alone php script works.

[xdebug]
zend_extension="xdebug.so"
xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.client_port="9003"

I am not sure what I could be missing

---

EDIT This is the php.ini config that ended up working

[xdebug]
zend_extension = xdebug
xdebug.mode=debug,develop
xdebug.start_with_request=yes

This is the command

wp eval-file test-debug.php --use-include --skip-wordpress

Answer 1

Since wp-cli version 2.8.0 the --use-include flag makes XDebug work with wp eval-file as it will use include() for the file instead of using eval().

See more here:

https://make.wordpress.org/cli/2023/05/31/wp-cli-v2-8-0-release-notes/

https://github.com/wp-cli/eval-command/issues/49