Debug CLI Script using php Tools

DeveloperscentralNet

I am using Codeigniter 4 as a php framework. Can anyone tell me how to debug a cli script ?
I tried using

> php set XDEBUG_MODE=debug& set XDEBUG_SESSION=1 {script_controller} {script_method}

but it doesn't work.

MiloslavBeno

Hello,

Thank you for the question.

I assume you have created PHP Web Application? But you want to debug a script separately as a CLI.

What you can do now is to go to Project Properties (right click on project node in the Solution Explorer), Server tab, and select Custom server. This option will be listening for Xdebug connection without running anything. Then you would run your script in the console and it should break.

Please let me know if that helped.

Thank you

DeveloperscentralNet

I tried what you said, script runs normally but didn't break. Please let me know where I am doing wrong.

MiloslavBeno

I guess in this case you wouldn't need to debug the controller as cli.

Make sure that web root is set to public, you would see it in the Solution Explorer as a blue icon instead of folder.

You can set it in the project properties, Application tab.

Than you can set the server as PHP Build-in server and place a breakpoint into your controller. Then press F5.

If you really want to debug it as CLI, or you have other server already setup, then "Custom" is the way to go. Just make sure Server URL is setup before pressing F5

In both cases the breakpoint should get hit in the controller:

Please let me know if that helped.

DeveloperscentralNet

Maybe I am not able to make you understand my requirement.
The way you debug the solution using visual studio (F5) is already known to me and there is no problem with it.
But try to understand I need to run the code via CMD only and function output must be visible to cmd only.
And the controller method is running fine via cmd just debugging is not working.
using this :
https://www.codeigniter.com/user_guide/cli/index.html

DeveloperscentralNet

https://www.codeigniter.com/user_guide/cli/cli_controllers.html

This is what exactly I am a trying to do, is there any way to run this using vs(F5) ?
As the CLI route must be call via CLI only otherwise where it will print the console output ... Hope you got my point.

MiloslavBeno

Got it.

Then "Custom" server settings is a way to go here (same as in my previous post). In this case, you also have to make sure Xdebug is properly setup. Also if you do not want to start the browser, go to the Application tab and select "Don't open a page. Wait for a request from an external application".

Then run the cmd:

If that doesn't work I would check xdebug.log whether PHP is correctly reaching the IDE.

DeveloperscentralNet

Thanks for your kind reply but unfortunately I am not able to replicate that on my machine.
As told i select "Don't open a page. Wait for a request from an external application".

Even after that on F5 web browser is opening with this
url : http://localhost:8080/index.php?XDEBUG_SESSION_START=271DE431

Then on the CMD I run the following command under public folder

set XDEBUG_SESSION=1
php index.php DataUpdaterCli

Then the function runs and shows the output on my CMD but same no breakpoints hit.

DeveloperscentralNet

Attaching all the screenshot for better understanding.

MiloslavBeno

Thanks for the provided details.

It seems Xdebug is just not getting back to the IDE. Please check the debug output pane if there are any information.

If not, alter the php.ini and add:

xdebug.log = path to xdebug.log

Please provide me with the log, I will check that.

Thank you

DeveloperscentralNet

This is log file
[8316] Log opened at 2022-09-06 05:07:22.000774 [8316] [Config] INFO: Trigger value for 'XDEBUG_TRIGGER' not found, falling back to 'XDEBUG_SESSION' [8316] [Config] INFO: Trigger value for 'XDEBUG_SESSION' not found, so not activating [8316] [Config] INFO: Trigger value for 'XDEBUG_TRIGGER' not found, falling back to 'XDEBUG_SESSION' [8316] [Config] INFO: Trigger value for 'XDEBUG_SESSION' not found, so not activating [8316] [Config] INFO: Trigger value for 'XDEBUG_TRIGGER' not found, falling back to 'XDEBUG_SESSION' [8316] [Config] INFO: Trigger value for 'XDEBUG_SESSION' not found, so not activating [8316] Log closed at 2022-09-06 05:07:22.086323

MiloslavBeno

Thank you!

Now it's clear. Try to run this before executing php:

$env:XDEBUG_SESSION = 1

set has different meaning in the powershell than in CMD. https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/set-variable?view=powershell-7.2

Please let me know if that helped.

DeveloperscentralNet

Yeeeees !
Finally its working.
Thanks a ton for your hard-work to help me out.
Hopefully this entire conversation will help other PHP lovers.
God bless you all.

MiloslavBeno

Perfect! I'm glad I could help.

DeveloperscentralNet Hopefully this entire conversation will help other PHP lovers.

I hope as well.

Have a great day!