Xdebug laravel artisan commands

Question

I regularly use xdebug to debug applications, I've built a laravel application that takes an upload of a csv inserts the data to the database and the ids to a job queue.

I've written an artisan command to be run via cron to then do something with this data.

Xdebug works for accessing the site via the browser, but its not breaking on breakpoints when ran from cli.

I run php5-fpm. My files /etc/php5/fpm/php.ini and /etc/php5/cli/php/ini both contain the following settings:

zend_extension=/usr/lib/php5/20121212/xdebug.so 
xdebug.remote_enable = 1 
xdebug.idekey = 'dev_docker' 
xdebug.remote_autostart = 1 
xdebug.remote_connect_back = {{my host ip}} 
xdebug.remote_port = 9000 
xdebug.remote_handler=dbgp

I then run the artisan command

php artisan jobqueue::process --batch-size=10 --sleep=10

I know the command is running as ->info('text') is displayed in the terminal

Anyone know what I'm missing?

This related question looks helpful to me: stackoverflow.com/q/27936323/470749 — Ryan
– Ryan, Commented Sep 22, 2017 at 22:31
Had the same problem, took me more than an hour to figure it out, here's a working solution stackoverflow.com/questions/1947395/… — 8ctopus
– 8ctopus, Commented May 18, 2020 at 8:15

boroboris · Accepted Answer · 2019-02-15 19:17:44Z

39

Maybe this will help someone.

In short I had the same problem but I didn't have luck with accepted answer. My solution is to run this from the command line:

php -dxdebug.remote_enable=1 -dxdebug.remote_autostart=on -dxdebug.remote_mode=req -dxdebug.remote_port=9000 -dxdebug.remote_host=127.0.0.1 artisan my:command

edited Feb 15, 2019 at 19:17

answered Nov 11, 2016 at 10:24

boroboris

1,6201 gold badge20 silver badges33 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Ryan Over a year ago

This didn't work for me. Netbeans still just says "running" and didn't stop at the marked line.

Dragas Over a year ago

You should add dxdebug.remote_autostart=on

Ryan Over a year ago

Hi Boroboris, could you please see if you could answer this related one? stackoverflow.com/questions/54711818/…

jayarjo Over a year ago

This should be marked as correct answer. xdebug.remote_autostart=on was the one.

Nickson Yap Over a year ago

If using docker: -dxdebug.remote_host=host.docker.internal

|

Alex · Accepted Answer · 2023-08-21 07:32:52Z

14

If you're using XDebug version 3, try:

php -dxdebug.mode=debug -dxdebug.client_host=host.docker.internal -dxdebug.client_port=9003 -dxdebug.start_with_request=yes artisan your:command

Update 2023-08

I'm using xDebug v3.2.1, php v8.2. Add these lines to xdebug.ini file if you don't want to write those long command every time. /etc/php/8.2/modes-available/xdebug.ini

zend_extension=xdebug.so
xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.client_port=9003
xdebug.start_with_request=yes

edited Aug 21, 2023 at 7:32

Alex

1,21810 silver badges32 bronze badges

answered Feb 22, 2021 at 15:45

Richard Arets

1411 silver badge3 bronze badges

1 Comment

Johan Fredrik Varen Over a year ago

This was all I needed: php -dxdebug.mode=debug -dxdebug.start_with_request=yes artisan my:command

Pepijn · Accepted Answer · 2020-02-10 07:21:42Z

3

I got it working with remote_autostart=1 and setting the PHP_IDE_CONFIG environment variable to "serverName=localhost". localhost is the name of your server config in PHPStorm. Now when I run php artisan I can break at the regular breakpoints.

Let me be more clear :)

If you've got xdebug working with PHPStorm and regular requests this is what you should do to get it working with command line php (artisan).

You have configured paths in PHPStorm so it knows which file it should show you with the breakpoints. These paths are configured under a server (Preferences -> Languages & Frameworks -> PHP -> Servers).

The name of this server should be the serverName value in the PHP_IDE_CONFIG environment variable.

edited Feb 10, 2020 at 7:21

answered Feb 9, 2020 at 10:45

Pepijn

1,48718 silver badges16 bronze badges

1 Comment

Hilman Nihri Over a year ago

finally! I was using the right xdebug config but xdebug always fail. The issue was I need to set the server config in phpstorm with the right port and xdebug is running.

yaroslawww · Accepted Answer · 2021-07-08 13:58:29Z

3

If you use vagrant, than you can create artisandebug shell file.

#!/bin/bash
HOST=10.0.2.2

# xdebug 3
php -dxdebug.mode=debug -dxdebug.start_with_request=yes -dxdebug.client_host=$HOST -dxdebug.client_port=9003 artisan  "$@"

# xdebug < 3
# php -dxdebug.remote_autostart=on -dxdebug.remote_connect_back=off -dxdebug.remote_host=$HOST -dxdebug.client_port=9003 artisan  "$@"

Than make it executable and run command :

chmod +x artisandebug

./artisandebug some:command --there

edited Jul 8, 2021 at 13:58

answered May 28, 2021 at 13:40

yaroslawww

1,08810 silver badges13 bronze badges

Comments

Furgas · Accepted Answer · 2015-11-08 11:34:54Z

1

According to xdebug.remote_connect_back documentation it's using $_SERVER['REMOTE_ADDR'] to get debugging host. I guess that in CLI you must use xdebug.remote_host instead.

answered Nov 8, 2015 at 11:34

Furgas

2,8541 gold badge20 silver badges29 bronze badges

1 Comment

Ryan Over a year ago

Hi Furgas, could you please see if you could answer this related one? stackoverflow.com/questions/54711818/…

Agafonov · Accepted Answer · 2021-11-21 19:07:26Z

0

For profiling with xdebug 3.1.1 and docker

php 
-dxdebug.mode=profile 
-dxdebug.client_host=IP_SERVICE_WITH_PHP 
-dxdebug.client_port=XDEBUG_CLINT_PORT 
-dxdebug.start_with_request=yes 
-dxdebug.output_dir=/tmp 
artisan ARTISAN_COMMAND

Example

php -dxdebug.mode=profile -dxdebug.client_host=172.19.0.3 -dxdebug.client_port=9003 -dxdebug.start_with_request=yes -dxdebug.output_dir=/tmp artisan help

answered Nov 21, 2021 at 19:07

Agafonov

211 bronze badge

Comments

Suraj Rao · Accepted Answer · 2021-12-01 14:14:55Z

0

php -dxdebug.mode=debug -dxdebug.client_host=localhost -dxdebug.client_port=9003 -dxdebug.start_with_request=yes artisan ARTISAN_COMMAND

edited Dec 1, 2021 at 14:14

Suraj Rao

29.7k11 gold badges96 silver badges104 bronze badges

answered Dec 1, 2021 at 14:14

Gastón García

11

1 Comment

Nico Haase Over a year ago

Please add some explanation to your answer such that others can learn from it

Jan Zoutendijk · Accepted Answer · 2022-09-01 11:47:33Z

0

An alternative approach would be to:

First start debugger
Run: php artisan tinker
Within tinker run: Artisan::call('your-command');

answered Sep 1, 2022 at 11:47

Jan Zoutendijk

135 bronze badges

Collectives™ on Stack Overflow

Xdebug laravel artisan commands

8 Answers 8

6 Comments

Update 2023-08

1 Comment

1 Comment

Comments

1 Comment

Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

8 Answers 8

6 Comments

Update 2023-08

1 Comment

1 Comment

Comments

1 Comment

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related